Merge pull request cerebral#37 from cerebral/effects

refactor(overmind): replace context and providers term with effects

Author: christianalfoni

…kages/demos/todomvc/src/app/providers.ts packages/demos/todomvc/src/app/effects.tspackages/demos/todomvc/src/app/providers.ts renamed to packages/demos/todomvc/src/app/effects.ts packages/demos/todomvc/src/app/providers.ts renamed to packages/demos/todomvc/src/app/effects.ts

@@ -1,17 +1,17 @@
-import App, { TConnect, TContext, IAction } from 'overmind/react'
-import * as providers from './providers'
+import App, { TConnect, TEffects, TAction } from 'overmind/react'
+import * as effects from './effects'
 import actions from './actions'
 import state from './state'
 
-export type Context = TContext<typeof state, typeof providers>
+export type Effects = TEffects<typeof state, typeof effects>
 
-export type Action = IAction<typeof state, Context>
+export type Action = TAction<typeof state, Effects>
 
 const app = new App(
   {
     state,
     actions,
-    providers,
+    effects,
   },
   {
     devtools: 'localhost:1234',

packages/demos/todomvc/src/app/index.ts

@@ -6,10 +6,10 @@ export class StopExecution {
     this.value = value
   }
 }
-export class ActionBase<Context, InitialValue, Value = InitialValue> {
+export class ActionBase<Effects, InitialValue, Value = InitialValue> {
   static nextActionId: number = 0
   private initialActionId: number
-  private actionChain: ActionChain<Context>
+  private actionChain: ActionChain<Effects>
   private runOperators: (
     value: any,
     executionContext: {
@@ -19,7 +19,7 @@ export class ActionBase<Context, InitialValue, Value = InitialValue> {
     newPath?: string
   ) => any | Promise<any>
   constructor(
-    actionChain: ActionChain<Context>,
+    actionChain: ActionChain<Effects>,
     initialActionId: number = ActionBase.nextActionId++,
     runOperators?: (
       value: any,
@@ -88,7 +88,7 @@ export class ActionBase<Context, InitialValue, Value = InitialValue> {
     type: string,
     name: string,
     cb: any
-  ): [ActionChain<Context>, number, any] => {
+  ): [ActionChain<Effects>, number, any] => {
     return [
       this.actionChain,
       this.initialActionId,
@@ -117,7 +117,7 @@ export class ActionBase<Context, InitialValue, Value = InitialValue> {
 
           const path = executionContextWithPath.__path
 
-          const context = this.actionChain.getContext(
+          const effects = this.actionChain.getEffects(
             thisExecution,
             executionContextWithPath
           )
@@ -128,7 +128,7 @@ export class ActionBase<Context, InitialValue, Value = InitialValue> {
             path,
             ...thisExecution,
           })
-          const result = cb(context, currentValue)
+          const result = cb(effects, currentValue)
 
           if (result instanceof Promise) {
             this.actionChain.emit('operator:async', {

packages/node_modules/action-chain/src/ActionBase.ts

@@ -61,9 +61,9 @@ function isObject(value) {
   return typeof value === 'object' && !Array.isArray(value) && value !== null
 }
 
-export class ActionChain<Context> extends EventEmitter<ActionChainEvents> {
+export class ActionChain<Effects> extends EventEmitter<ActionChainEvents> {
   constructor(
-    private context: Context,
+    private effects: Effects,
     private options: ActionChainOptions = {}
   ) {
     super()
@@ -107,26 +107,26 @@ export class ActionChain<Context> extends EventEmitter<ActionChainEvents> {
     }
   }
 
-  getContext(thisExecution: Execution, executionContext: ExecutionContext) {
-    let context = this.context
+  getEffects(thisExecution: Execution, executionContext: ExecutionContext) {
+    let effects = this.effects
 
     if (IS_DEVELOPMENT) {
-      context = Object.keys(this.context).reduce((currentContext, key) => {
+      effects = Object.keys(this.effects).reduce((currentEffects, key) => {
         if (
           this.options.providerExceptions.indexOf(key) === -1 &&
-          isObject(this.context[key])
+          isObject(this.effects[key])
         ) {
-          currentContext[key] = new Proxy(this.context[key], {
+          currentEffects[key] = new Proxy(this.effects[key], {
             get: this.createGetHandler(thisExecution, key),
           })
         } else {
-          currentContext[key] = this.context[key]
+          currentEffects[key] = this.effects[key]
         }
 
-        return currentContext
-      }, {}) as Context
+        return currentEffects
+      }, {}) as Effects
     }
 
-    return Object.assign({}, context, executionContext)
+    return Object.assign({}, effects, executionContext)
   }
 }

packages/node_modules/action-chain/src/ActionChain.ts

@@ -127,7 +127,7 @@ describe('CONTEXT', () => {
 })
 
 describe('PROVIDER', () => {
-  test('should track execution of providers', () => {
+  test('should track execution of effects', () => {
     expect.assertions(2)
     const fn = action().test(({ foo }) => {
       expect(foo.bar()).toBe('baz')
@@ -146,7 +146,7 @@ describe('PROVIDER', () => {
     })
     fn()
   })
-  test('should track execution of namespaced providers', () => {
+  test('should track execution of namespaced effects', () => {
     expect.assertions(2)
     const fn = action().test(({ foo }) => {
       expect(foo.nestedProvider.bar()).toBe('baz')
@@ -165,7 +165,7 @@ describe('PROVIDER', () => {
     })
     fn()
   })
-  test('should track execution of class instance providers', () => {
+  test('should track execution of class instance effects', () => {
     expect.assertions(2)
     const fn = action().test(({ test }) => {
       expect(test.foo()).toBe('bar')

packages/node_modules/action-chain/src/index.test.ts

@@ -1,16 +1,16 @@
-import App, { TConnect, TContext, IAction } from 'overmind/react'
-import * as providers from './providers'
+import App, { TConnect, TEffects, TAction } from 'overmind/react'
+import * as effects from './effects'
 import actions from './actions'
 import state from './state'
 
-export type Context = TContext<typeof state, typeof providers>
+export type Context = TEffects<typeof state, typeof effects>
 
-export type Action = IAction<typeof state, Context>
+export type Action = TAction<typeof state, Context>
 
 const app = new App({
   state,
   actions,
-  providers,
+  effects,
 })
 
 export type Connect = TConnect<typeof app.state, typeof app.actions>