Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Coffeescript/Javascript method combinations for Underscore projects

branch: master
README.md

You Are 'Da Chef

What is it?

This library adds before, after, around, and guard method combinations to underscore.js projects, in much the same style as the Common Lisp Object System or Ruby on Rails controllers. With method combinations, you can easily separate concerns.

For example:

class Wumpus
    roar: ->
        # ...
    run: ->
        #...

class Hunter
    draw: (bow) ->
        # ...
    quiver: ->
        # ...
    run: ->
        #...

hydrate = (object) ->
    # code that hydrates the object from storage

YouAreDaChef(Wumpus, Hunter)

    .before 'roar', 'draw', 'run', ->
        hydrate(this)

    .after 'roar', 'draw', ->
        @trigger 'action'

There must be more to it than that

Yes there is, there's a Quick Start Guide and a discussion of the special sauce, YouAreDaChef's inheritance model.

Is it any good?

Yes.

I don't believe you!

C'mon, meta-programmed code is read-only. It looks good, but when it comes time to debug or modify anything, it's a nightmare to step through it in the debugger and figure out what's going on.

That's often the case, but starting with version 1.0, YouAreDaChef is designed to make code that's easy to write, not just easy to read. Instead of blindly patching methods with wrapper functions, YouAreDaChef stores all of the "advice" functions in a special data structure in the class. You can inspect each class separately. You can provide names for the advice you add to methods, which makes it easier to keep track of the advice you have provided. Since you have the advice and can inspect it, you can write unit tests for your advice and debug the advice you have provided more easily. The .inspect function does add some code complexity to the YouAreDaChef library, but it makes writing and debugging code written with the YouAreDaChef library much easier.

Can I use it with pure Javascript?

Yes.

Can I install it with npm?

Yes:

npm install YouAreDaChef

Will it make me smarter?

No, but it can make you appear smarter. Just explain that guard advice is a monad:

YouAreDaChef(EnterpriseyLegume)

  .when /write(.*)/, ->
    @user.hasPermission('write', match[1])

Guard advice works like a before combination, with the bonus that if it returns something falsely, the pointcut will not be executed. This behaviour is similar to the way ActiveRecord callbacks work.

You can also try making a cryptic reference to a computed, non-local COMEFROM.

I might not need all of its awesomeness

Have a look at method-combinators.

Where can I read more?

Quick Start Guide
Separating Concerns in CoffeeScript using Aspect-Oriented Programming
Implementing Garbage Collection in CS/JS with Aspect-Oriented Programming

In memoriam

YouAreDaChef's method advice is loosely based on Lisp Flavors, specifically the inheritance of before and after advice plus the overriding of default advice (called daemon in Flavors). Dan Weinreb (d. 2012) played an important role in the development of Lisp. He is missed by many.

post scriptum

I'm writing a book called CoffeeScript Ristretto. Check it out!

Et cetera

YouAreDaChef was created by Reg "raganwald" Braithwaite. It is available under the terms of the MIT License.

Something went wrong with that request. Please try again.