Merge pull request #1 from reactor-studio/develop

Merge develop into master

Author: dinodsaurus

.all-contributorsrc

@@ -0,0 +1,30 @@
+{
+  "projectName": "re-create-actions",
+  "projectOwner": "reactor-studio",
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": true,
+  "contributors": [
+    {
+      "login": "wedranb",
+      "name": "Vedran Blazenka",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/1723170?v=4",
+      "profile": "https://www.vblazenka.com/",
+      "contributions": [
+        "code",
+        "doc"
+      ]
+    },
+    {
+      "login": "dinodsaurus",
+      "name": "Dino Trojak",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/1530952?v=4",
+      "profile": "http://reactor.studio",
+      "contributions": [
+        "code"
+      ]
+    }
+  ]
+}

.babelrc

@@ -0,0 +1,23 @@
+{
+  "presets": [
+    "es2015",
+    ["env", {
+      "modules": false
+    }]
+  ],
+  "env": {
+    "production": {
+      "plugins": [
+        "external-helpers",
+        "transform-object-rest-spread"
+      ]
+    },
+    "test":{
+      "plugins": [
+        "transform-runtime", 
+        "external-helpers",
+        "transform-object-rest-spread"
+      ]
+    }
+  }
+}

.editorconfig

@@ -0,0 +1,17 @@
+
+root = true
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitignore

@@ -0,0 +1 @@
+node_modules

.travis.yml

@@ -0,0 +1,4 @@
+language: node_js
+node_js:
+  - "7"
+  - "8"

README.md

@@ -0,0 +1,98 @@
+# Introduction
+[![Build Status](https://travis-ci.org/reactor-studio/re-create-actions.svg?branch=master)](https://travis-ci.org/reactor-studio/re-create-actions)
+[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors)
+
+
+Reduce boilerplate of your Redux actions by creating [flux-standard-actions](https://github.com/acdlite/flux-standard-action) with a set of utilities this package provides.
+
+## TL;DR
+
+```javascript
+// actions.js
+import {
+  createAction,
+  createRequestTypes,
+  createRequestActions
+} from 're-create-actions';
+
+// Constans
+const GET_GITHUB_USERS = 'GET_GITHUB_USERS';
+
+// Create action creator
+export const getGithubUsers = createAction(GET_GITHUB_USERS);
+// Use: dispatch(getGithubUsers())
+
+// Create network types/constants
+const GET_GITHUB_USERS_RT = createRequestTypes('GET_GITHUB_USERS_RT');
+// Use: GET_GITHUB_USERS_RT.REQUESTED, GET_GITHUB_USERS_RT.COMPLETED, GET_GITHUB_USERS_RT.FAILED
+
+// Create actions from network types
+const getGithubUsersRT = createRequestActions(GET_GITHUB_USERS_RT);
+// Use: dispatch(getGithubUsersRT.requested())
+
+```
+
+# Install
+
+### NPM
+```bash
+$ npm install re-create-actions --save
+```
+
+### Yarn
+```bash
+$ yarn add re-create-actions
+```
+
+# Usage
+Every helper will create action that is defined in shape by Flux standard action. We decided to go with Flux standard action because it gives you definition of minimal, common standards that are human-friendly and enable
+us to create assumptions about the shape of our actions.
+
+*NOTE*: You can't disable flux standard action structure at the moment. But there is an [open issue]() for this.
+
+# API
+
+## createAction (type, payloadCreator, metaCreator)
+
+#### type (required)
+Type: `string`
+
+Type for your type property in [action](https://redux.js.org/basics/actions)
+
+#### payloadCreator (optional)
+Type: `function`
+
+Custom payload creator for action payload
+
+#### metaCreator (optional)
+Type: `function`
+
+Custom meta creator for action
+
+
+# createRequestTypes(type)
+
+#### type
+Type: `string`
+
+Type for your request types
+
+## Credits
+Projects was inspired by headaches given from reading bunch of boilerplates during pull request reveiws at [reactor.studio](https://github.com/reactor-studio`).
+
+API for this package was inspired by this awesome projects:
+* [flux-standard-action](https://github.com/acdlite/flux-standard-action)
+* [redux-actions](https://github.com/reduxactions/redux-actions)
+
+
+## Contributors
+
+Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore -->
+| [<img src="https://avatars3.githubusercontent.com/u/1723170?v=4" width="100px;"/><br /><sub><b>Vedran Blazenka</b></sub>](https://www.vblazenka.com/)<br />[💻](https://github.com/reactor-studio/re-create-actions/commits?author=wedranb "Code") [📖](https://github.com/reactor-studio/re-create-actions/commits?author=wedranb "Documentation") | [<img src="https://avatars2.githubusercontent.com/u/1530952?v=4" width="100px;"/><br /><sub><b>Dino Trojak</b></sub>](http://reactor.studio)<br />[💻](https://github.com/reactor-studio/re-create-actions/commits?author=dinodsaurus "Code") |
+| :---: | :---: |
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!

package.json

@@ -2,23 +2,46 @@
   "name": "re-create-actions",
   "version": "0.0.1",
   "description": "Group of utilities for creating Flux standard actions.",
-  "main": "src/index.js",
+  "main": "dist/bundle.js",
   "repository": "https://github.com/reactor-studio/re-create-actions",
   "author": "Vedran Blazenka <[email protected]>",
   "license": "MIT",
+  "ava": {
+    "require": [
+      "babel-register"
+    ],
+    "babel": "inherit"
+  },
   "scripts": {
-    "test": "xo && ava"
+    "build": "NODE_ENV=production rollup -c",
+    "test": "NODE_ENV=test xo && ava",
+    "contributors:add": "all-contributors add",
+    "contributors:generate": "all-contributors generate"
   },
   "devDependencies": {
     "ava": "^0.25.0",
-    "xo": "^0.18.2"
+    "babel-plugin-external-helpers": "^6.22.0",
+    "babel-plugin-transform-object-rest-spread": "^6.26.0",
+    "babel-plugin-transform-runtime": "^6.23.0",
+    "babel-preset-env": "^1.6.1",
+    "babel-preset-es2015": "^6.24.1",
+    "babelrc-rollup": "^3.0.0",
+    "rollup": "^0.56.2",
+    "rollup-plugin-babel": "^3.0.3",
+    "rollup-plugin-commonjs": "^8.3.0",
+    "rollup-plugin-node-resolve": "^3.0.2",
+    "xo": "^0.20.3"
   },
   "dependencies": {
-    "flux-standard-action": "^2.0.1"
+    "flux-standard-action": "^2.0.1",
+    "invariant": "^2.2.2",
+    "lodash": "^4.17.5"
   },
   "xo": {
     "esnext": true,
     "space": 2,
-    "kebab": false
+    "ignores": [
+      "rollup.config.js"
+    ]
   }
 }

rollup.config.js

@@ -0,0 +1,26 @@
+import resolve from 'rollup-plugin-node-resolve';
+import babel from 'rollup-plugin-babel';
+import babelrc from 'babelrc-rollup';
+// import commonjs from 'rollup-plugin-commonjs';
+
+const pkg = require('./package.json');
+
+const external = Object.keys(pkg.dependencies);
+
+const plugins = [
+  resolve({
+    jsnext: true,
+    main: true
+  }),
+  babel(babelrc()),
+];
+
+export default {
+  entry: 'src/index.js',
+  output: {
+    file: 'dist/index.js',
+    format: 'cjs'
+  },
+  plugins: plugins,
+  external: external,
+}

src/__tests__/create-action.test.js

@@ -1,43 +1,40 @@
 import test from 'ava';
+
+import {isFSA} from 'flux-standard-action';
 import createAction from '../create-action';
-import createRequestTypes from '../create-request-types';
-import createActionsFromTypes from '../create-actions-from-types';
 
 // Constants
 const SIMPLE_ACTION_CONSTANT = 'SIMPLE_ACTION_CONSTANT';
 
 let simpleAction;
-let SIMPLE_NETWORK_CONSTANT_RT;
-let simpleActionConstantRT;
 
 // Prepare tests
 test.before(() => {
   // Create action creator without payload
   simpleAction = createAction(SIMPLE_ACTION_CONSTANT);
+});
 
-  // Create network constants with suffixes
-  SIMPLE_NETWORK_CONSTANT_RT = createRequestTypes('SIMPLE_NETWORK_CONSTANT_RT');
-
-  // Create action creators from network constants
-  simpleActionConstantRT = createActionsFromTypes(SIMPLE_NETWORK_CONSTANT_RT);
+test('createActions returns valid flux standard action', t => {
+  t.is(isFSA(simpleAction()), true);
 });
 
 test('createAction should return action creator with a type', t => {
   t.deepEqual(simpleAction(), {
-    type: SIMPLE_ACTION_CONSTANT
-  });
-});
-
-test('createRequestTypes should return a list of types with request suffixes', t => {
-  t.deepEqual(SIMPLE_NETWORK_CONSTANT_RT, {
-    REQUESTED: SIMPLE_NETWORK_CONSTANT_RT.REQUESTED,
-    COMPLETED: SIMPLE_NETWORK_CONSTANT_RT.COMPLETED,
-    FAILED: SIMPLE_NETWORK_CONSTANT_RT.FAILED
+    type: SIMPLE_ACTION_CONSTANT,
+    error: false
   });
 });
 
-test('createActionsFromTypes should return a list of action creators with request types', t => {
-  t.deepEqual(simpleActionConstantRT.requested(), {
-    type: SIMPLE_NETWORK_CONSTANT_RT.REQUESTED
+test('createAction should return action with custom payload', t => {
+  const customPayloadAction = createAction(SIMPLE_ACTION_CONSTANT, payload => ({
+    newProp: payload
+  }));
+
+  t.deepEqual(customPayloadAction('lorem ispum'), {
+    type: SIMPLE_ACTION_CONSTANT,
+    payload: {
+      newProp: 'lorem ispum'
+    },
+    error: false
   });
 });

src/__tests__/create-config.test.js

@@ -0,0 +1,12 @@
+import test from 'ava';
+import createConfig from '../create-config';
+
+test('should set config and return it', t => {
+  const config = createConfig({
+    requestSuffixes: ['R', 'C', 'F']
+  });
+
+  t.deepEqual(config, {
+    requestSuffixes: ['R', 'C', 'F']
+  });
+});