Merge pull request #9 from Yoctol/naming

rename XState to Xstate
bottenderjs · Aug 16, 2018 · f6b3bcd · f6b3bcd
2 parents 44b45b6 + 25b34f2
commit f6b3bcd
Show file tree

Hide file tree

Showing 9 changed files with 51 additions and 51 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,7 +3,7 @@
 - [new] Implement basic usage:
 
 ```js
-const bottenderXState = require('bottender-xstate');
+const bottenderXstate = require('bottender-xstate');
 
 const config = {
   key: 'light',
@@ -33,7 +33,7 @@ const config = {
   },
 };
 
-const mapContextToXStateEvent = () => 'TIMER';
+const mapContextToXstateEvent = () => 'TIMER';
 
 const actionMap = {
   enterGreen: context => context.sendText('enter green'),
@@ -45,9 +45,9 @@ const actionMap = {
 };
 
 bot.onEvent(
-  bottenderXState({
+  bottenderXstate({
     config,
-    mapContextToXStateEvent,
+    mapContextToXstateEvent,
     actionMap,
   })
 );

diff --git a/README.md b/README.md
@@ -16,15 +16,15 @@ npm install bottender-xstate
 
 | Param                   | Type           | Description                                  |
 | ----------------------- | -------------- | -------------------------------------------- |
-| config                  | `XStateConfig` | Config to be passed to xstate.               |
-| mapContextToXStateEvent | `Function`     | Mapper for create xstate event from context. |
+| config                  | `XstateConfig` | Config to be passed to xstate.               |
+| mapContextToXstateEvent | `Function`     | Mapper for create xstate event from context. |
 | actionMap               | `Object`       | Map of named actions.                        |
 | guards                  | `Object`       | Map of named guards.                         |
 | onEvent                 | `Function`     | Callback to be called when trigger event.    |
 | onAction                | `Function`     | Callback to be called when trigger action.   |
 
 ```js
-const bottenderXState = require('bottender-xstate');
+const bottenderXstate = require('bottender-xstate');
 
 const config = {
   key: 'light',
@@ -54,7 +54,7 @@ const config = {
   },
 };
 
-const mapContextToXStateEvent = () => 'TIMER';
+const mapContextToXstateEvent = () => 'TIMER';
 
 const actionMap = {
   enterGreen: context => context.sendText('enter green'),
@@ -66,9 +66,9 @@ const actionMap = {
 };
 
 bot.onEvent(
-  bottenderXState({
+  bottenderXstate({
     config,
-    mapContextToXStateEvent,
+    mapContextToXstateEvent,
     actionMap,
   })
 );

diff --git a/examples/basic.js b/examples/basic.js
@@ -1,6 +1,6 @@
 const { ConsoleBot } = require('bottender');
 
-const bottenderXState = require('../src');
+const bottenderXstate = require('../src');
 
 const bot = new ConsoleBot();
 
@@ -32,7 +32,7 @@ const config = {
   },
 };
 
-const mapContextToXStateEvent = () => {
+const mapContextToXstateEvent = () => {
   const event = 'TIMER';
 
   console.log(`Event: ${event}`);
@@ -50,9 +50,9 @@ const actionMap = {
 };
 
 bot.onEvent(
-  bottenderXState({
+  bottenderXstate({
     config,
-    mapContextToXStateEvent,
+    mapContextToXstateEvent,
     actionMap,
   })
 );

diff --git a/examples/hierarchical.js b/examples/hierarchical.js
@@ -1,6 +1,6 @@
 const { ConsoleBot } = require('bottender');
 
-const bottenderXState = require('../src');
+const bottenderXstate = require('../src');
 
 const bot = new ConsoleBot();
 
@@ -57,7 +57,7 @@ const config = {
   },
 };
 
-const mapContextToXStateEvent = () => {
+const mapContextToXstateEvent = () => {
   const event = Math.random() > 0.5 ? 'TIMER' : 'PED_TIMER';
 
   console.log(`Event: ${event}`);
@@ -81,9 +81,9 @@ const actionMap = {
 };
 
 bot.onEvent(
-  bottenderXState({
+  bottenderXstate({
     config,
-    mapContextToXStateEvent,
+    mapContextToXstateEvent,
     actionMap,
   })
 );

diff --git a/examples/history.js b/examples/history.js
@@ -1,6 +1,6 @@
 const { ConsoleBot } = require('bottender');
 
-const bottenderXState = require('../src');
+const bottenderXstate = require('../src');
 
 const bot = new ConsoleBot();
 
@@ -35,7 +35,7 @@ const config = {
 
 let count = 0;
 
-const mapContextToXStateEvent = () => {
+const mapContextToXstateEvent = () => {
   count += 1;
 
   let event;
@@ -69,9 +69,9 @@ const actionMap = {
 };
 
 bot.onEvent(
-  bottenderXState({
+  bottenderXstate({
     config,
-    mapContextToXStateEvent,
+    mapContextToXstateEvent,
     actionMap,
   })
 );

diff --git a/examples/named_guards.js b/examples/named_guards.js
@@ -1,6 +1,6 @@
 const { ConsoleBot } = require('bottender');
 
-const bottenderXState = require('../src');
+const bottenderXstate = require('../src');
 
 const bot = new ConsoleBot();
 
@@ -38,7 +38,7 @@ const config = {
   },
 };
 
-const mapContextToXStateEvent = () => {
+const mapContextToXstateEvent = () => {
   const event = 'TIMER';
 
   console.log(`Event: ${event}`);
@@ -56,9 +56,9 @@ const actionMap = {
 };
 
 bot.onEvent(
-  bottenderXState({
+  bottenderXstate({
     config,
-    mapContextToXStateEvent,
+    mapContextToXstateEvent,
     actionMap,
     guards: {
       randomly: () => {

diff --git a/examples/parallel.js b/examples/parallel.js
@@ -1,7 +1,7 @@
 const { ConsoleBot } = require('bottender');
 const randomItem = require('random-item');
 
-const bottenderXState = require('../src');
+const bottenderXstate = require('../src');
 
 const bot = new ConsoleBot();
 
@@ -77,7 +77,7 @@ const config = {
   },
 };
 
-const mapContextToXStateEvent = () => {
+const mapContextToXstateEvent = () => {
   const event = randomItem([
     'TOGGLE_BOLD',
     'TOGGLE_UNDERLINE',
@@ -114,9 +114,9 @@ const actionMap = {
 };
 
 bot.onEvent(
-  bottenderXState({
+  bottenderXstate({
     config,
-    mapContextToXStateEvent,
+    mapContextToXstateEvent,
     actionMap,
   })
 );

diff --git a/src/__tests__/index.spec.js b/src/__tests__/index.spec.js
@@ -1,4 +1,4 @@
-const bottenderXState = require('../');
+const bottenderXstate = require('../');
 
 const config = {
   key: 'light',
@@ -28,7 +28,7 @@ const config = {
   },
 };
 
-const mapContextToXStateEvent = () => 'TIMER';
+const mapContextToXstateEvent = () => 'TIMER';
 
 const actionMap = {
   enterGreen: context => context.sendText('enter green'),
@@ -40,9 +40,9 @@ const actionMap = {
 };
 
 it('should call match actions', async () => {
-  const handler = bottenderXState({
+  const handler = bottenderXstate({
     config,
-    mapContextToXStateEvent,
+    mapContextToXstateEvent,
     actionMap,
   });
 
@@ -59,9 +59,9 @@ it('should call match actions', async () => {
 });
 
 it('should call setState with xstate state value', async () => {
-  const handler = bottenderXState({
+  const handler = bottenderXstate({
     config,
-    mapContextToXStateEvent,
+    mapContextToXstateEvent,
     actionMap,
   });
 
@@ -85,9 +85,9 @@ it('should call setState with xstate state value', async () => {
 });
 
 it('should load state from session', async () => {
-  const handler = bottenderXState({
+  const handler = bottenderXstate({
     config,
-    mapContextToXStateEvent,
+    mapContextToXstateEvent,
     actionMap,
   });
 
@@ -123,9 +123,9 @@ it('should load state from session', async () => {
 
 it('should call onEvent with event', async () => {
   const onEvent = jest.fn();
-  const handler = bottenderXState({
+  const handler = bottenderXstate({
     config,
-    mapContextToXStateEvent,
+    mapContextToXstateEvent,
     actionMap,
     onEvent,
   });
@@ -143,9 +143,9 @@ it('should call onEvent with event', async () => {
 
 it('should call onAction with action name', async () => {
   const onAction = jest.fn();
-  const handler = bottenderXState({
+  const handler = bottenderXstate({
     config,
-    mapContextToXStateEvent,
+    mapContextToXstateEvent,
     actionMap,
     onAction,
   });
@@ -164,7 +164,7 @@ it('should call onAction with action name', async () => {
 
 it('should support named guards', async () => {
   const someCond = jest.fn(() => true);
-  const handler = bottenderXState({
+  const handler = bottenderXstate({
     config: {
       key: 'light',
       initial: 'green',
@@ -181,7 +181,7 @@ it('should support named guards', async () => {
         },
       },
     },
-    mapContextToXStateEvent,
+    mapContextToXstateEvent,
     actionMap,
     guards: {
       someCond,

diff --git a/src/index.js b/src/index.js
@@ -1,9 +1,9 @@
 const warning = require('warning');
 const { State, Machine } = require('xstate');
 
-function bottenderXState({
+function bottenderXstate({
   config,
-  mapContextToXStateEvent,
+  mapContextToXstateEvent,
   actionMap,
   guards = {},
   onEvent,
@@ -12,12 +12,12 @@ function bottenderXState({
   return async context => {
     const machine = Machine(config, { guards });
 
-    const contextXState = context.state.xstate;
+    const contextXstate = context.state.xstate;
 
-    const currentState = contextXState
-      ? new State(contextXState.value, contextXState.historyValue)
+    const currentState = contextXstate
+      ? new State(contextXstate.value, contextXstate.historyValue)
       : machine.initialState;
-    const event = await mapContextToXStateEvent(context);
+    const event = await mapContextToXstateEvent(context);
 
     if (onEvent) {
       onEvent(event, context);
@@ -49,4 +49,4 @@ function bottenderXState({
   };
 }
 
-module.exports = bottenderXState;
+module.exports = bottenderXstate;