organize your application logic into manageable components
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
spec
.gitignore
.jshintignore
.jshintrc
.travis.yml
Gruntfile.js
LICENSE
README.md
bower.json
component.json
index.js
package.json

README.md

logicbox.js

NPM version Build Status Coverage Status Dependency Status devDependency Status

Logicbox is a utility to organize your application logic into managable components seprate from your transport layer. The concept of this module is inspired by Architecture the Lost Years keynote by Robert Martin and the implementation is inspired by substation.

Installation

npm install logicbox --save

Quick Example

var env = {
    logger: require('./logger'),
    utils:  require('./utils'),
    models: require('./models')
};

var createUser = function(env, input, cb) {
  env.models.User.create(input, function(err, user) {
    if(err) { return cb(err); }

    env.logger.log("user created!");
    cb(null, user);
  }
};

var errLogger = function(env, output, err) {
    if(err) { env.logger.log(err); }
}

var config = {
  options: {
    basePath: require('path').join(process.pwd(), 'usecases')
  },
  actions: {
    createUser: {
      handler: createUser,
      observer: errLogger
  }
};

// give logicbox an application environment and config, and you are good to go.
var dispatch = require('logicbox')(env, config);

server.post('/users', function(req, res) {
  var user = request.params.user;

  // dispatch 'createUser' action with user as the input
  dispatch('createUser', user, function(err, user) {
    if(err) { return response.error(err); }
    response.end(user);
  });
});

Actions

An action encapsulates a peiece of business logic, or use case. It must contain at least one handler, and can optionally contain one or more pre / post processors and observers. It is configured in config.actions object.

The simplest example:

// config.js
module.exports = {
  actions: {
    createUser: 'usecases/user/create'
  }
}

This example creates an action named createUser and the handler is specified in usecases/user/create. The value of actions options can contain:

  • String - Logicbox requires supplied string by appending options.basePath.
  • Function - It is used directly. Signature: function(env, input, cb){...}.
  • Object - See below.

Specifying an action with action object:

// config.js
module.exports = {
  actions: {
    createPost: {
      handler: 'usecases/post/create',
      pre:  [
        'preprocessors/authenticate',
        'preprocessors/authorize'
      ],
      post: [
        'postprocessors/convert-to-api-objects',
        'postprocessors/add-hypermedia-links',
        'postprocessors/convert-to-json'
      ],
      observer: [
        'observers/log-event',
        'observers/send-email'
      ]
  }
}

The action object must have a handler, and can optionally specify pre, post, observer keys. handler can accept string or function. pre, post, observer can accept string, function or array.

Global processors and observers

// config.js
module.exports = {
  global: {
    pre:  [
      // ...
    ],
    post: [
      // ...
    ],
    observer: [
      // ...
    ]
  }
}

Similarly, you can define global pre, post, observer.

Execution Order

The order is: global.pre -> pre -> handler -> post -> global.post -> callback. Each processor / handler's output becomes the input of the next. If an error is returned in any part of the chain, the execution is halted, and the callback function will be run with the error. If the entire chain is completed, the callback is invoked with the output of the last handler / processor in the chain.

observers will be invoked after the completion of the chain. observers have the signature of function(env, output, err, done); and the done callback does not take any arguments, so errors has to be handled within the observer. The order for observers is observer -> global.observer.

Signatures

Pre / Post processors and handlers all have the following signature:

function(env, input, callback)

The callback is a standard node.js style callback, and has the following signature:

function(error, output)

Observers have the following signature:

function(env, output, error, done)

The done callback should be called when a observer is completed. Errors inside Observers should be handled internally. As the done callback does not accept errors.

Example Handler

module.exports = function(env, input, callback) {
  // hopefully the input is santized by a pre-processor
  // and is data-massaged into something usable when it reaches here.
  env.models.User.create(input, function(error, user) {
    // something went wrong, let Logicbox know.
    if(err) { return callback(error); }

    // everyting is peachy, continue down the chain.
    // maybe a post process will use `user` as their input,
    // or this could be the end of the chain, in that case
    // the dispatcher's callback will get the result.
    callback(null, user);
  });
}