文件列表:

LICENSE-MIT (1058, 2013-12-03)
Makefile (357, 2013-12-03)
PantaRhei.js (8433, 2013-12-03)
PantaRhei.min.js (5963, 2013-12-03)
docs (0, 2013-12-03)
docs\PantaRhei.html (36596, 2013-12-03)
docs\docco.css (7207, 2013-12-03)
docs\public (0, 2013-12-03)
docs\public\fonts (0, 2013-12-03)
docs\public\fonts\aller-bold.eot (29804, 2013-12-03)
docs\public\fonts\aller-bold.ttf (66836, 2013-12-03)
docs\public\fonts\aller-bold.woff (33244, 2013-12-03)
docs\public\fonts\aller-light.eot (29509, 2013-12-03)
docs\public\fonts\aller-light.ttf (68620, 2013-12-03)
docs\public\fonts\aller-light.woff (33124, 2013-12-03)
docs\public\fonts\novecento-bold.eot (18190, 2013-12-03)
docs\public\fonts\novecento-bold.ttf (48136, 2013-12-03)
docs\public\fonts\novecento-bold.woff (20576, 2013-12-03)
docs\public\stylesheets (0, 2013-12-03)
docs\public\stylesheets\normalize.css (6874, 2013-12-03)
package.json (619, 2013-12-03)
src (0, 2013-12-03)
src\PantaRhei.coffee (6810, 2013-12-03)
src\PantaRhei.workers.coffee (2412, 2013-12-03)
test (0, 2013-12-03)
test\testFlow.coffee (5749, 2013-12-03)

#PantaRhei.js v 0.2.0 (c) 2012 [Federico Weber](http://federicoweber.com) distributed under the MIT license. **PantaRhei.js** is a middleware pattern implementation for [Backbone.js], written in CoffeeScript. The purpose of PantaRhei is to ease the creation and the execution of queues of tasks, like fetching and manipulating data, managing the transitions between pages and so on. Right now PantaRhei is composed by two modules: the **Flow**, that is responsible for the execution of the queue and the **Worker**, that describe one of the possible structure of middleware[^2] that the Flow can handle. ### The Worker The **Worker** module is more a convention than a real module, and it's meant to be extended. It describe two methods: the former is the **run** it's invoked by the Flow to execute the worker and accept a **shared** object ( which purpose is to act as a place for workers to share data ) and the **next** callback as arguments; the latter is the **kill**, that is invoked by the Flow when the worker execution is completed to safely remove it. The worker constructor also accept an option **id** as an argument. To create a new Worker you need to extend it and implement it's methods: var Delay = PantaRhei.Worker.extend({ constructor: function(duration, id){ this.duration = duration; this.id = id; }, run: function(shared, next) { onTimeout = function(){ next(); }; setTimeout(onTimeout, duration); }, kill: function(){ // all your logics to remove the worker } }); var shortDelay = new Delay(1000, 'shortDelay'); PantaRhei also include, under the PantaRhei.workers namespace, a series of workers[^3] JsonLoader and LoadAssets. ### The Flow The **Flow** module is our middleware manager, and handle for you all the logic to create and run the queue. To create a new flow all you have to do is to call it's constructor and optionally pass two parameters: an **id** and a array containing the list of **workers** to use. var flow = new PantaRhei.Flow( 'myFirstFlow', [task1, task2] ); You can also append a worker to the flow passing it as an argument of the **use** method. var task1 = function(shared, next){ console.log( "task one completed" ); next(); }, flow = new PantaRhei.Flow( ); flow.use(task1); To execute the flow you have to invoke the **run** method. The flow can also accept an optional **shared** object. This is passed around to all the workers in the queue and it's returned by the flow on complete, it's actually the place for storing and passing data between workers. If this is not provided the Flow will create a empty object to use. // create our workers var task1 = function(shared, next){ shared.data = "the data have been processed" next(); }, task2 = function(shared, next){ shared.newData = "we got some new data for you" next(); }, // create our flow and workers passing the first task on the constructor flow = new PantaRhei.Flow( 'myFirstFlow', [ task1 ]); flow // append the second task .use( task2 ) // run the flow .run({data: "the data is new"}); #### Check values of the shared object Sometimes it is useful to interrupt the flow if the data processed from the flow till a given point are invalid, or differ fro the expected ones. To ease this kind of data check the Flow comes with a **check** method; To check the data in the shared object you just need to provide an object with all the expected keys and values pair. If all the values in the shared object match our test, the flow will continue with the execution, otherwise it will terminate; cleaning the running queue and firing both the *terminate* and *complete* events. flow .on('complete', function(){ $('#main').append("flow completed
"); }) .on('terminate', function(){ $('#main').append("flow terminated
"); }) .use(function(shared, next){next()}) .check({test: 'it', num: 0}) .use(function(shared, next){next()}) .run({test: 'it', num: 1}); #### Events PantaRhei make use of the Backbone Events, so the Flow can dispatch the following events: *run, pause, resume, error, terminate and complete*. Apart from the error all the other events pass the shared object as an argument to the listener. So to get notified when a flow have been successfully executed you can catch the complete event. var onComplete = function( shared ){ console.log(shared); }; flow .on( 'complete', onComplete) .run(); #### Error handling PantaRhei leave the responsibility to properly handle the errors to you. If any of the worker in the queue pass and error to the next callback, the Flow is paused and dispatch an **error** event. Once you have done with the error handling and you are ready to resume the flow you can call the **resume** method to move to the next worker in the queue. var onError = function( err ){ //handle the error in here this.resume(); }; flow .on( 'error', onError) .run(); --- I hope you will find this useful, if you have questions or suggestion you can reach me via [Twitter](http://twitter.com/FedericoWeber) or [ADN](https://alpha.app.net/federicoweber). [Gestalt]:http://federicoweber.com/gestaltapp/20120625-142551-pi-3-introducinggestalt [Backbone.js]:http://backbonejs.org [Express.js]:http://expressjs.com [Connect]:http://www.senchalabs.org/connect/ [^1]: If you are looking for an introduction to the use of middle wares in Connect I suggest you to check this short [guide](http://stephensugden.com/middleware_guide/) written by Stephen Sugden. [^2]:The other one is a simple function that accept as arguments the **shared** object and the **next** callback. [^3]: More to follow soon.

近期下载者：

相关文件：

评论：[我要评论] [举报此文件]

收藏者：