Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Functional controllers #482

Merged
merged 3 commits into from
Sep 17, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions packages/cx/src/data/View.js
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,17 @@ export class View {
this.store = store;
this.meta = store.getMeta();
}

getMethods() {
return {
getData: ::this.getData,
set: ::this.set,
get: ::this.get,
update: ::this.update,
delete: ::this.delete,
toggle: ::this.toggle
}
}
}

View.prototype.sealed = false; //indicate that data should be copied before virtual items are added
2 changes: 2 additions & 0 deletions packages/cx/src/ui/Component.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ interface DecoratorFactory<T> {

export class Component {

constructor(config?: Cx.Config);

init();

/**
Expand Down
48 changes: 48 additions & 0 deletions packages/cx/src/ui/Controller.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import {computable} from '../data/computable';
import {Component} from './Component';
import {isArray} from '../util/isArray';
import {isFunction} from '../util/isFunction';
import {View} from "../data/View";

const computablePrefix = 'computable-';
const triggerPrefix = 'trigger-';
Expand Down Expand Up @@ -87,3 +89,49 @@ export class Controller extends Component {

Controller.namespace = 'ui.controller.';
Controller.lazyInit = true;

Controller.factory = function(alias, config, more) {
if (isFunction(alias)) {
let cfg = {
...config,
...more
};

if (cfg.instance) {
//in rare cases instance.store may change, so we cannot rely on the store passed through configuration
cfg.store = new InstanceStoreProxy(cfg.instance);
Object.assign(cfg, cfg.store.getMethods());
}

let result = alias(cfg);
if (result instanceof Controller)
return result;

return new Controller({
...config,
...more,
...result
});
}

return new Controller({
...config,
...more
});
};

class InstanceStoreProxy extends View {
constructor(instance) {
super({
store: instance.store
});

Object.defineProperty(this, "store", {
get: () => instance.store
});
}

getData() {
return this.store.getData();
}
}
128 changes: 119 additions & 9 deletions packages/cx/src/ui/Controller.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@ describe('Controller', () => {
}

let widget = <cx>
<div controller={TestController} />
<div controller={TestController}/>
</cx>;

let store = new Store();

const component = renderer.create(
<Cx widget={widget} store={store} subscribe immediate />
<Cx widget={widget} store={store} subscribe immediate/>
);

let tree = component.toJSON();
Expand Down Expand Up @@ -75,7 +75,7 @@ describe('Controller', () => {

const component = renderer.create(
<Cx store={store} subscribe immediate>
<Cmp controller={TestController} onTest="callback" />
<Cmp controller={TestController} onTest="callback"/>
</Cx>
);

Expand Down Expand Up @@ -115,7 +115,7 @@ describe('Controller', () => {
const component = renderer.create(
<Cx store={store} subscribe immediate>
<div controller={TestController1}>
<Cmp controller={TestController2} onTest="callback1" />
<Cmp controller={TestController2} onTest="callback1"/>
</div>
</Cx>
);
Expand Down Expand Up @@ -146,7 +146,7 @@ describe('Controller', () => {
const component = renderer.create(
<Cx store={store} subscribe immediate>
<div controller={TestController1}>
<div controller={TestController2} />
<div controller={TestController2}/>
</div>
</Cx>
);
Expand Down Expand Up @@ -176,7 +176,7 @@ describe('Controller', () => {
const component = renderer.create(
<Cx store={store} subscribe immediate>
<div controller={TestController1}>
<div visible={false} controller={TestController2} />
<div visible={false} controller={TestController2}/>
</div>
</Cx>
);
Expand All @@ -187,6 +187,7 @@ describe('Controller', () => {

it('invokes triggers and computables in order of definition', () => {
let log = [];

class TestController extends Controller {
onInit() {
this.addTrigger('t1', [], () => {
Expand All @@ -205,13 +206,13 @@ describe('Controller', () => {
}

let widget = <cx>
<div controller={TestController} />
<div controller={TestController}/>
</cx>;

let store = new Store();

const component = renderer.create(
<Cx widget={widget} store={store} subscribe immediate />
<Cx widget={widget} store={store} subscribe immediate/>
);

let tree = component.toJSON();
Expand All @@ -220,6 +221,7 @@ describe('Controller', () => {

it('is recreated if a component is hidden and shown', () => {
let initCount = 0;

class TestController extends Controller {
onInit() {
initCount++;
Expand All @@ -231,7 +233,7 @@ describe('Controller', () => {

const component = renderer.create(
<Cx store={store} subscribe immediate>
<div visible:bind="visible" controller={TestController} />
<div visible:bind="visible" controller={TestController}/>
</Cx>
);

Expand All @@ -246,5 +248,113 @@ describe('Controller', () => {
let tree3 = component.toJSON();
assert.equal(initCount, 2);
});

it('allows creation through a factory', () => {
let store = new Store({ data: { x: 0}});

const controllerFactory = ({store}) => {
return {
increment() {
store.update("x", x => x + 1);
}
}
};

let c = Controller.create(controllerFactory, {store});

c.increment();
assert.equal(store.get("x"), 1);
});

it('lifetime methods of a functional controller are properly invoked', () => {
let initCount = 0,
destroyCount = 0;

const testController = () => ({
onInit() {
initCount++;
},

onDestroy() {
destroyCount++;
}
});

let store = new Store();
store.set('visible', true);

const component = renderer.create(
<Cx store={store} subscribe immediate>
<div visible:bind="visible" controller={testController}/>
</Cx>
);

let tree1 = component.toJSON();
assert.equal(initCount, 1);

store.set('visible', false);
let tree2 = component.toJSON();
assert.equal(destroyCount, 1);

store.set('visible', true);
let tree3 = component.toJSON();
assert.equal(initCount, 2);
});

it('widgets can easily define controller methods', () => {
let store = new Store({ data: { x: 0}});

const component = renderer.create(
<Cx store={store} subscribe immediate>
<div
controller={{
increment(count) {
this.store.update("x", x => x + count);
}
}}
>
<div
controller={{
onInit() {
this.invokeParentMethod("increment", 1);
}
}}
/>
</div>


</Cx>
);

let tree1 = component.toJSON();
assert.equal(store.get("x"), 1);
});

it('functional controllers get store methods through configuration', () => {
let store = new Store({ data: { x: 0}});

const component = renderer.create(
<Cx store={store} subscribe immediate>
<div
controller={({update}) => ({
increment(count) {
update("x", x => x + count);
}
})}
>
<div
controller={{
onInit() {
this.invokeParentMethod("increment", 1);
}
}}
/>
</div>
</Cx>
);

let tree1 = component.toJSON();
assert.equal(store.get("x"), 1);
});
});