Merge pull request #29 from adamyonk/add_tape

Add tape support and docs

Author: dmitry-zaets

README.md

@@ -12,6 +12,7 @@ It use [redux-mock-store](https://github.com/arnaudbenard/redux-mock-store) to m
 - [expect](https://redux-things.github.io/redux-actions-assertions/expect.html)
 - [expect.js](https://redux-things.github.io/redux-actions-assertions/expectjs.html)
 - [should](https://redux-things.github.io/redux-actions-assertions/should.html)
+- [tape](https://redux-things.github.io/redux-actions-assertions/tape.html)
 - [pure javascript assertion](https://redux-things.github.io/redux-actions-assertions/javascript.html)
 
 If you have not found assertion framework/library that you are using - please add comment into [this issue](https://github.com/dmitry-zaets/redux-actions-assertions/issues/3).

docs/javascript.md

@@ -2,14 +2,12 @@
 
 ## Registration
 
-For plain javascript assertions you don't need to register anything. Just import assertions in your tests:
-
 ```js
 // using ES6 modules
-import assertions from 'redux-actions-assertions';
+import { assertions } from 'redux-actions-assertions';
 
 // using CommonJS modules
-var assertions = require('redux-actions-assertions');
+var assertions = require('redux-actions-assertions').assertions;
 
 // in test
 assertions.toDispatchActions(/**/)
@@ -18,6 +16,8 @@ assertions.toDispatchActionsWithState(/**/);
 assertions.toNotDispatchActionsWithState(/**/);
 ```
 
+For plain javascript assertions you don't need to register anything. Just import assertions in your tests:
+
 ## Usage
 
 ### toDispatchActions
@@ -56,4 +56,4 @@ Same as `toNotDispatchActions` + asserts that store initialised with `state` bef
 
 ```js
 toNotDispatchActions({property: 'value'}, testActionCreator(), [{ type: 'MY_ACTION_START' }], callback);
-```
+```

docs/tape.md

@@ -0,0 +1,72 @@
+# [tape](https://github.com/substack/tape)
+
+## Usage
+
+```js
+// using ES6 modules
+import test from 'tape'
+import { assertions } from 'redux-actions-assertions'
+
+// using CommonJS modules
+var test = require('tape')
+var assertions = require('redux-actions-assertions').assertions;
+```
+
+Usage is the same as the [plain JavaScript assertions](https://redux-things.github.io/redux-actions-assertions/javascript.html), you just need to set up the correct `pass` and `fail` callbacks. Also, be sure to call `end` in a `Promise.then`, or `plan` with the number of assertions you're making in the test (see below).
+
+### toDispatchActions
+> `toDispatchActions(action, expectedActions, done, fail)`
+
+Asserts that when given `action` is dispatched it will dispatch `expectedActions`. `action` can be plain object (action) or function (action creator). `expectedActions` can be can be plain object (action) or function (action creator) or array of objects/functions.
+
+```js
+// Using `t.plan`
+test('Thunk: editTag', (t) => {
+  t.plan(1)
+  toDispatchActions(testActionCreator(), [{ type: 'MY_ACTION_START' }], t.pass, t.fail);
+})
+
+// Using `t.end`
+test('Thunk: editTag', (t) => {
+  toDispatchActions(testActionCreator(), [{ type: 'MY_ACTION_START' }], t.pass, t.fail)
+    .then(t.end);
+})
+```
+
+### toNotDispatchActions
+> `toNotDispatchActions(action, expectedActions, done, fail)`
+
+Asserts that when given `action` is dispatched it will not dispatch `expectedActions`. `action` can be plain object (action) or function (action creator). `expectedActions` can be can be plain object (action) or function (action creator) or array of objects/functions.
+
+```js
+test('Thunk: editTag', (t) => {
+  t.plan(1)
+  toNotDispatchActions(testActionCreator(), [{ type: 'MY_ACTION_START' }], t.pass, t.fail);
+})
+```
+
+### toDispatchActionsWithState
+
+> `toDispatchActionsWithState(initialState, action, expectedActions, done, fail)`
+
+Same as `toDispatchActions` + asserts that store initialised with `state` before `action` is dispatched.
+
+```js
+test('Thunk: editTag', (t) => {
+  t.plan(1)
+  toDispatchActions({property: 'value'}, testActionCreator(), [{ type: 'MY_ACTION_START' }], t.pass, t.fail);
+})
+```
+
+### toNotDispatchActionsWithState
+
+> `toNotDispatchActionsWithState(initialState, action, expectedActions, done, fail)`
+
+Same as `toNotDispatchActions` + asserts that store initialised with `state` before `action` is dispatched.
+
+```js
+test('Thunk: editTag', (t) => {
+  t.plan(1)
+  toNotDispatchActions({property: 'value'}, testActionCreator(), [{ type: 'MY_ACTION_START' }], t.pass, t.fail);
+})
+```

package.json

@@ -8,7 +8,8 @@
     "test:expect": "mocha --compilers js:babel-register --reporter spec test/expect/*.js",
     "test:expectjs": "mocha --compilers js:babel-register --reporter spec test/expectjs/*.js",
     "test:should": "mocha --compilers js:babel-register --reporter spec test/should/*.js",
-    "test": "npm run test:index && npm run test:chai && npm run test:expect && npm run test:expectjs && npm run test:should",
+    "test:tape": "tape --require babel-register test/tape/*.js",
+    "test": "npm run test:index && npm run test:chai && npm run test:expect && npm run test:expectjs && npm run test:should && npm run test:tape",
     "prepublish": "rimraf build && babel src --out-dir build --copy-files"
   },
   "repository": {
@@ -38,7 +39,8 @@
     "mocha": "^2.4.5",
     "redux-thunk": "^2.1.0",
     "rimraf": "^2.5.2",
-    "should": "^8.3.2"
+    "should": "^8.3.2",
+    "tape": "^4.6.0"
   },
   "dependencies": {
     "redux-actions-assertions-js": "^1.1.0"

test/tape/index.js

@@ -0,0 +1,32 @@
+import test from 'tape';
+import thunk from 'redux-thunk';
+
+import { assertions, registerMiddlewares } from '../../src';
+import actions from '../testingData/actions';
+
+registerMiddlewares([thunk]);
+
+test('tape', t => {
+  t.plan(1);
+  const msg = 'should pass with t.plan';
+
+  assertions.toDispatchActionsWithState(
+    { property: 'value' },
+    actions.actionCreatorWithGetState(),
+    actions.actionWithGetState({ property: 'value' }),
+    t.pass.bind(this, msg),
+    t.fail.bind(this, msg)
+  );
+});
+
+test('tape', t => {
+  const msg = 'should pass with t.end';
+
+  assertions.toDispatchActionsWithState(
+    { property: 'value' },
+    actions.actionCreatorWithGetState(),
+    actions.actionWithGetState({ property: 'value' }),
+    t.pass.bind(this, msg),
+    t.fail.bind(this, msg)
+  ).then(t.end);
+});