creamer

Version:

A flatiron plugin for dynamic coffeecup templates

89 lines (72 loc) • 13.3 kB

HTML

<!DOCTYPE html> <html> <head> <title>index.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> index.coffee </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> <h1>Creamer</h1> A flatiron http plugin that adds <code>coffeecup</code> templates to your flatiron application install <pre><code>npm install creamer </code></pre> usage <pre><code>flatiron = require 'flatiron' creamer = require 'creamer' app = flatiron.app layout = require __dirname + '/views/layout' app.use creamer, layout: layout app.router.get '/', -> @res.html @bind -> h1 'Hello World' app.start 3000 </code></pre> <hr /> require coffeecup <a href="http://github.com/gradus/coffeecup">http://github.com/gradus/coffeecup</a> </td> <td class="code"> <div class="highlight"><pre>cc = require 'coffeecup' hardcode = require 'coffeecup-helpers' fs = require 'fs' wrench = require 'wrench'</pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> broadway plug attach method Plugin Options <pre><code>Options | Description -------------|---------------------------------------- layout | CoffeeCup Template with content method views | Add your views directory and creamer will pre-register your views controllers | Add your controllers directory and creamer will mount your controllers </code></pre> </td> <td class="code"> <div class="highlight"><pre>exports.attach = (options={}) -> self = this</pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> <h2>load views by view directory</h2> by passing the viewDir as an option creamer will load your views </td> <td class="code"> <div class="highlight"><pre> registeredViews = {} if options.views? items = wrench.readdirSyncRecursive(options.views) for view in items if view.match /(.js|.coffee)/ fn = require options.views + '/' + view name = view.split('.').shift() registeredViews[name] = fn</pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> <h2>load controllers by controller directory</h2> by passing the controllers as an option creamer will load your controllers </td> <td class="code"> <div class="highlight"><pre> if options.controllers? items = wrench.readdirSyncRecursive(options.controllers) for controller in items if controller.match /(.js|.coffee)/ fn = require options.controllers + '/' + controller</pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> mount controllers </td> <td class="code"> <div class="highlight"><pre> @router.mount fn</pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> <h2>app.bind(page, data)</h2> <pre><code>Parameter | Type | Required? | Description -------------|-----------|-------------|------------------------- page | function | yes | coffeecup template data | object | no | any data you want to pass to your template </code></pre> </td> <td class="code"> <div class="highlight"><pre> @bind = (page, data) -> page = registeredViews[page] if typeof page is 'string' if options.layout? and typeof page is 'function' hardcode.content = page cc.render(options.layout, data, { hardcode, locals: true }) else if typeof page is 'function' cc.render(page, data, { hardcode, locals: true}) else 'Not Found'</pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">¶</a> </div> <h2>app.registerHelper(name, fn)</h2> <pre><code>Parameter | Type | Required? | Description -------------|-----------|-------------|------------------------- name | string | yes | name of helper fn | functio | yes | coffeecup function </code></pre> </td> <td class="code"> <div class="highlight"><pre> @registerHelper = (name, fn) -> valid = cc.compile(fn, {hardcode, locals: true}) hardcode[name] = fn if typeof fn is 'function'</pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">¶</a> </div> <h2>app.registerView(name, fn)</h2> <pre><code>Parameter | Type | Required? | Description -------------|-----------|-------------|------------------------- name | string | yes | name of helper fn | functio | yes | coffeecup function </code></pre> </td> <td class="code"> <div class="highlight"><pre> @registerView = (name, fn) -> valid = cc.compile(fn, {hardcode, locals: true}) registeredViews[name] = fn</pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">¶</a> </div> if flatiron router exists, then attach creamers bind function </td> <td class="code"> <div class="highlight"><pre> @router.attach ( -> @bind = self.bind ) if @router?.attach?</pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">¶</a> </div> init plugin method </td> <td class="code"> <div class="highlight"><pre>exports.init = (done) -> done() </pre></div> </td> </tr> </tbody> </table> </div> </body> </html>