Skip to content

dispatchToParents problem #72

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.

Sign up for GitHub

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

Open
creynders wants to merge 1 commit into
base: master
Choose a base branch
from
Open

dispatchToParents problem #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 12 additions & 7 deletions backbone.geppetto.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,27 +202,32 @@
return target.listenToOnce(this.vent, eventName, callback, target);
},

dispatch: function dispatch(eventName, eventData) {
_extendEventData: function(eventName, eventData) {
if (!_.isUndefined(eventData) && !_.isObject(eventData)) {
throw "Event payload must be an object";
}
eventData = eventData || {};
eventData.eventName = eventName;
return eventData;
},

dispatch: function dispatch(eventName, eventData) {
eventData = this._extendEventData(eventName, eventData);
this.vent.trigger(eventName, eventData);
},

dispatchToParent: function dispatchToParent(eventName, eventData) {
if (this.parentContext) {
this.parentContext.vent.trigger(eventName, eventData);
this.parentContext.dispatch(eventName, eventData);
}
},

dispatchToParents: function dispatchToParents(eventName, eventData) {
if (this.parentContext && !(eventData && eventData.propagationDisabled)) {
this.parentContext.vent.trigger(eventName, eventData);
if (this.parentContext) {
this.parentContext.dispatchToParents(eventName, eventData);
}
eventData = this._extendEventData(eventName, eventData);
var context = this.parentContext;
while (context && !eventData.propagationDisabled) {
context.vent.trigger(eventName, eventData);
context = context.parentContext;
}
},

Expand Down
130 changes: 123 additions & 7 deletions specs/src/geppetto-specs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -666,6 +666,7 @@ define([
parentView.close();
});


it("should set the 'parentContext' attribute on the child context", function() {
expect(childContext.parentContext).to.equal(parentContext);
});
Expand All @@ -686,6 +687,60 @@ define([
expect(spy.callCount).to.equal(1);
});

it("should throw an error when a non-object data payload is supplied", function() {

var errMsg = "Event payload must be an object";

expect(function() {
childContext.dispatchToParent("foo", 1);
}).to.throw (errMsg);

expect(function() {
childContext.dispatchToParent("foo", "a string");
}).to.throw (errMsg);

expect(function() {
childContext.dispatchToParent("foo", null);
}).to.throw (errMsg);

expect(function() {
childContext.dispatchToParent("foo", true);
}).to.throw (errMsg);

// accept optional payload

expect(function() {
childContext.dispatchToParent("foo", undefined);
}).not.to.throw ();

expect(function() {
childContext.dispatchToParent("foo", {});
}).not.to.throw ();

});

it("should pass to parent event with default payload when none initially supplied", function() {
var payload;
parentContext.listen(parentView, "foo", function(data) {payload = _.extend({}, data)});
childContext.dispatchToParent("foo");

expect(payload).to.eql({"eventName": "foo"});
});

it("should extend original payload with eventName when dispatching with a payload", function() {
var payload = {"foo": "bar", "nb": 1};
parentContext.listen(parentView, "foo", function(data) {
if (_.isObject(data) && _.isNumber(data.nb)) {
data.nb++;
}
payload = _.extend({}, data)}
);
childContext.dispatchToParent("foo", payload);

expect(payload).to.eql({"eventName": "foo", "foo": "bar", "nb": 2});
});


it("should dispatch a context shutdown event to the parent when the child context is closed", function() {
var spy = sinon.spy();
parentContext.listen(parentView, Geppetto.EVENT_CONTEXT_SHUTDOWN, spy);
Expand Down Expand Up @@ -748,7 +803,43 @@ define([
greatGrandParentView.close();
});

it("should pass event without data payload to all ancestors", function () {
it("should throw an error when a non-object is supplied as data payload", function () {

var errMsg = "Event payload must be an object";

expect(function() {
childContext.dispatchToParents("foo", 1);
}).to.
throw (errMsg);

expect(function() {
childContext.dispatchToParents("foo", "a string");
}).to.
throw (errMsg);

expect(function() {
childContext.dispatchToParents("foo", null);
}).to.
throw (errMsg);

expect(function() {
childContext.dispatchToParents("foo", true);
}).to.
throw (errMsg);

// accept optional payload

expect(function() {
childContext.dispatchToParents("foo", undefined);
}).not.to.throw();

expect(function() {
childContext.dispatchToParents("foo", {});
}).not.to.throw();

});

it("should dispatch to all ancestors when no data payload supplied", function () {
var spyGGP = sinon.spy();
var spyGP = sinon.spy();
var spyP = sinon.spy();
Expand All @@ -767,7 +858,32 @@ define([
expect(spyGGP.callCount).to.equal(1);

});
it("should pass data payload all ancestors", function () {



it("should dispatch to all ancestors with default payload when no data payload supplied", function () {
var results = {};
var spyGGP = sinon.spy(function (data) { results.ggp = _.isObject(data) && data.eventName == 'foo';});
var spyGP = sinon.spy(function (data) { results.gp = _.isObject(data) && data.eventName == 'foo';});
var spyP = sinon.spy(function (data) { results.p = _.isObject(data) && data.eventName == 'foo';});
var spyC = sinon.spy(function (data) { results.c = _.isObject(data) && data.eventName == 'foo';});

greatGrandParentView.listen(greatGrandParentView, "foo", spyGGP);
grandParentView.listen( grandParentView, "foo", spyGP);
parentView.listen( parentView, "foo", spyP);
childView.listen( childView, "foo", spyC);

childContext.dispatchToParents('foo');

expect(spyC.callCount).to.equal(0);
expect(spyP.callCount).to.equal(1);
expect(spyGP.callCount).to.equal(1);
expect(spyGGP.callCount).to.equal(1);
expect(results).to.eql({"p": true, "gp": true, "ggp": true });

});

it("should extend supplied data payload with eventName and pass it to all ancestors", function () {
var dataGGP;
var dataGP;
var dataP;
Expand All @@ -791,17 +907,16 @@ define([

childContext.dispatchToParents('foo', {"foo": "bar"});

expect(dataGGP).to.eql({"foo": "bar"});
expect(dataGP).to.eql({"foo": "bar"});
expect(dataP).to.eql({"foo": "bar"});
expect(dataGGP).to.eql({"foo": "bar", "eventName": "foo"});
expect(dataGP).to.eql({"foo": "bar", "eventName": "foo"});
expect(dataP).to.eql({"foo": "bar", "eventName": "foo"});

});

it("should pass same data payload to all ancestors, not cloned objects", function () {
var dataGGP;
var dataGP;
var dataP;
var dataC;

var spyGGP = sinon.spy(function (data) {
dataGGP = data.foo;
Expand Down Expand Up @@ -830,7 +945,7 @@ define([
expect(dataGP).to.equal(2);
expect(dataP).to.equal(1);

expect(payload).to.eql({"foo": 4});
expect(payload).to.eql({"foo": 4, "eventName": "foo"});

});

Expand Down Expand Up @@ -858,6 +973,7 @@ define([
expect(spyGGP.callCount).to.equal(0);

});

it("should not crash if an ancestor destroys its own ancestor while bubbling", function() {

var destroyGGP = function() {
Expand Down