Merge pull request #16 from kjirou/develop

Develop v0.0.3

README.ja.md

@@ -5,17 +5,13 @@
 
 README: ( [English](/README.md) | [日本語](/README.ja.md) )
 
-乱雑なイベントの発火をキューで管理し、ビジネスロジックを定型的に書くためのモジュール
+乱雑なイベントの発火に対し、イベントハンドラの実行を直列化するフレームワーク
 
 
-## このモジュールの目的
-- ビジネスロジック（例えば、Flux の ActionCreator のような）を定型的に書きたい
-  - これは、多くのウェブ・フレームワークのように、ビジネスロジックを記述するための一定の書式を設けることで解決する
-- そのために、複数のビジネスロジックが同時に実行されることを抑止するのも必要だと思った
-  - 同じ変数に対し複数の処理が同時に参照・更新を行う可能性がある場合、データの整合性を担保するのが非常に難しい。
-    この一点の担保でビジネスロジック部分を書く際の難易度が大きく下がる。
-  - これは、イベントをキュー管理することによって解決する
-- CUI/CLIアプリでも使えるようにする
+## このモジュールの機能
+- イベントハンドラを記述するための枠組みを提供する。
+- ひとつのイベントハンドラをトランザクション処理として実行できるようにする。
+- イベントハンドラの実行をキューイングする。
 
 
 ## インストール方法
@@ -31,6 +27,52 @@ npm install --save downspout
 ### 概要
 ![](/doc/overview.png)
 
+```js
+const Downspout = require('downspout');
+
+const state = {
+  counter: 0,
+};
+
+const useCases = {
+  increment: () => {
+    return Promise.resolve({
+      type: 'INCREMENT',
+    });
+  },
+  decrement: () => {
+    return new Promise(resolve => {
+      setTimeout(() => {
+        resolve({
+          type: 'DECREMENT',
+        });
+      }, 1000);
+    });
+  },
+};
+
+const downspout = new Downspout(useCases);
+
+downspout.on('execution:resolved', ({ result: action }) => {
+  switch (action.type) {
+    case 'INCREMENT':
+      state.counter += 1;
+      break;
+    case 'DECREMENT':
+      state.counter -= 1;
+      break;
+  }
+
+  process.stdout.write(`${ state.counter }\n`);
+});
+
+downspout.execute('increment');  // -> "1"
+downspout.execute('increment');  // -> "2"
+downspout.execute('decrement');  // -> "1"
+downspout.execute('increment');  // -> "2"
+downspout.execute('decrement');  // -> "1"
+```
+
 ### 基本的な使い方を、CLI用サンプルカウンターアプリで解説
 - [最もシンプルな例](/examples/counter-1.js)
   - Keywords:
@@ -63,7 +105,7 @@ npm install --save downspout
     - EVENT_NAMES.USE_CASE_EXECUTION_REJECTED
 - [別のユースケースを呼び出す](/examples/counter-9.js)
   - Keywords:
-    - executor.fork
+    - utils.fork
 - [ユースケースとUIイベントを別レイヤーにしたい](/examples/counter-10.js)
   - Keywords:
     - routes

README.md

@@ -5,16 +5,13 @@
 
 README: ( [English](/README.md) | [日本語](/README.ja.md) )
 
-Queue the emitting of disorderly events and write business logics routinely
+Framework to serialize the execution of event handlers for disorderly event emitting
 
 
-## Purpose of this module
-- Define business logic (such as ActionCreator) routinely.
-  - This is solved by providing a format to describe to business logic like most of web frameworks.
-- Therefore, it prevents simultaneous execution of multiple business logic.
-  - It is very difficult to maintain consistency of data when multiple processes reference / update the same variable.
-  - This is solved by queuing events.
-- Make it available for CUI / CLI applications.
+## Functions of this module
+- Provide a framework for describing event handlers.
+- Allow one event handler to execute as transaction processing.
+- Queue the execution of event handlers.
 
 
 ## Installation
@@ -30,6 +27,52 @@ Please use [browserify](https://github.com/substack/node-browserify)
 ### Overview
 ![](/doc/overview.png)
 
+```js
+const Downspout = require('downspout');
+
+const state = {
+  counter: 0,
+};
+
+const useCases = {
+  increment: () => {
+    return Promise.resolve({
+      type: 'INCREMENT',
+    });
+  },
+  decrement: () => {
+    return new Promise(resolve => {
+      setTimeout(() => {
+        resolve({
+          type: 'DECREMENT',
+        });
+      }, 1000);
+    });
+  },
+};
+
+const downspout = new Downspout(useCases);
+
+downspout.on('execution:resolved', ({ result: action }) => {
+  switch (action.type) {
+    case 'INCREMENT':
+      state.counter += 1;
+      break;
+    case 'DECREMENT':
+      state.counter -= 1;
+      break;
+  }
+
+  process.stdout.write(`${ state.counter }\n`);
+});
+
+downspout.execute('increment');  // -> "1"
+downspout.execute('increment');  // -> "2"
+downspout.execute('decrement');  // -> "1"
+downspout.execute('increment');  // -> "2"
+downspout.execute('decrement');  // -> "1"
+```
+
 ### Basic usage by CLI counter samples
 - [The simplest example](/examples/counter-1.js)
   - Keywords:

examples/counter-overview.js

@@ -0,0 +1,45 @@
+#!/usr/bin/env node
+
+const Downspout = require('../index');
+
+const state = {
+  counter: 0,
+};
+
+const useCases = {
+  increment: () => {
+    return Promise.resolve({
+      type: 'INCREMENT',
+    });
+  },
+  decrement: () => {
+    return new Promise(resolve => {
+      setTimeout(() => {
+        resolve({
+          type: 'DECREMENT',
+        });
+      }, 1000);
+    });
+  },
+};
+
+const downspout = new Downspout(useCases);
+
+downspout.on('execution:resolved', ({ result: action }) => {
+  switch (action.type) {
+    case 'INCREMENT':
+      state.counter += 1;
+      break;
+    case 'DECREMENT':
+      state.counter -= 1;
+      break;
+  }
+
+  process.stdout.write(`${ state.counter }\n`);
+});
+
+downspout.execute('increment');  // -> "1"
+downspout.execute('increment');  // -> "2"
+downspout.execute('decrement');  // -> "1"
+downspout.execute('increment');  // -> "2"
+downspout.execute('decrement');  // -> "1"

package.json

@@ -1,7 +1,7 @@
 {
   "name": "downspout",
-  "version": "0.0.2",
-  "description": "Queue the emitting of disorderly events and write business logics routinely",
+  "version": "0.0.3",
+  "description": "Framework to serialize the execution of event handlers for disorderly event emitting",
   "main": "index.js",
   "scripts": {
     "test": "$(npm bin)/mocha",
@@ -36,5 +36,16 @@
   },
   "dependencies": {
     "rxjs": "5.0.0-rc.3"
-  }
+  },
+  "files": [
+    "LICENSE",
+    "README.md",
+    "doc",
+    "examples",
+    "index.js",
+    "lib",
+    "jsdoc",
+    "test",
+    "package.json"
+  ]
 }

test/lib/EventRouter.js

@@ -12,7 +12,7 @@ describe('lib/EventRouter', () => {
       });
     });
 
-    it('can parse an array of only one element', () => {
+    it('can parse an array of just one element', () => {
       assert.deepStrictEqual(EventRouter._parseRouteData(['createFoo']), {
         useCaseName: 'createFoo',
         fixedUseCaseArgs: [],