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.

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

Add space-delimited list of events support for triggerMethod #3457

Closed
wants to merge 1 commit into from
Closed

Add space-delimited list of events support for triggerMethod #3457

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
4 changes: 4 additions & 0 deletions docs/marionette.functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,10 @@ var myObj = new MyObject(); // console.log "baz"
Mn.triggerMethod(myObj, 'foo', 'qux'); // console.log "qux"
```

To trigger several events and corresponding methods split the events by the space. Example:

* `triggerMethod('foo bar')` fires the `onFoo` and the `onBar` functions

*Note*: Some Marionette classes such as Views have an overridden `triggerMethod`. Using `Mn.triggerMethod` with a view will break event proxying. If you need to run `triggerMethod` on a Marionette class [`triggerMethodOn`](#marionette-triggermethodon) is recommended.

## Marionette.triggerMethodOn
Expand Down
42 changes: 32 additions & 10 deletions src/common/trigger-method.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ import _ from 'underscore';
import getOption from './get-option';

// split the event name on the ":"
const splitter = /(^|:)(\w)/gi;
const colonSplitter = /(^|:)(\w)/gi;
const spaceSplitter = /\s+/;

// take the event section ("section1:section2:section3")
// and turn it in to uppercase name onSection1Section2Section3
Expand All @@ -14,26 +15,47 @@ function getEventName(match, prefix, eventName) {
}

const getOnMethodName = _.memoize(function(event) {
return 'on' + event.replace(splitter, getEventName);
return 'on' + event.replace(colonSplitter, getEventName);
});

function isManyEvents(events) {
return events && spaceSplitter.test(events);
}

function execEventMethod(event, args) {
// get the method name from the events name
const methodName = getOnMethodName(event);
const method = getOption.call(this, methodName);

// call the onMethodName if it exists
if (_.isFunction(method)) {
// pass all args, except the event name
return method.apply(this, args);
}
}

function execEventMethods(events, args) {
return events.split(spaceSplitter)
.filter(event => event.length > 0)
.map((event) => {
return execEventMethod.call(this, event, args);
});
}

// Trigger an event and/or a corresponding method name. Examples:
//
// `this.triggerMethod("foo")` will trigger the "foo" event and
// call the "onFoo" method.
//
// `this.triggerMethod("foo:bar")` will trigger the "foo:bar" event and
// call the "onFooBar" method.
export function triggerMethod(event, ...args) {
// get the method name from the event name
const methodName = getOnMethodName(event);
const method = getOption.call(this, methodName);
export function triggerMethod(events, ...args) {
let result;

// call the onMethodName if it exists
if (_.isFunction(method)) {
// pass all args, except the event name
result = method.apply(this, args);
if (isManyEvents(events)) {
result = execEventMethods.call(this, events, args);
} else {
result = execEventMethod.call(this, events, args);
}

// trigger the event
Expand Down
196 changes: 159 additions & 37 deletions test/unit/common/trigger-method.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,37 @@ describe('trigger event and method name', function() {
'use strict';

beforeEach(function() {
this.returnValue = 'foo';
this.argumentOne = 'bar';
this.argumentTwo = 'baz';
this.returnValue1 = 'foo';
this.returnValue2 = 'bar';
this.argumentOne = 'baz';
this.argumentTwo = 'bax';

this.eventHandler = this.sinon.stub();
this.methodHandler = this.sinon.stub().returns(this.returnValue);
this.eventHandler1 = this.sinon.stub();
this.eventHandler2 = this.sinon.stub();
this.methodHandler1 = this.sinon.stub().returns(this.returnValue1);
this.methodHandler2 = this.sinon.stub().returns(this.returnValue2);
});

describe('triggering an event when passed options', function() {
beforeEach(function() {
this.view = new Marionette.View({
onFoo: this.methodHandler
});
this.view = new Marionette.View({onFoo: this.methodHandler1});
this.view.triggerMethod('foo');
});

it('should trigger the event', function() {
expect(this.methodHandler).to.have.been.calledOnce;
expect(this.methodHandler1).to.have.been.calledOnce;
});
});

describe('triggering events when passed options', function() {
beforeEach(function() {
this.view = new Marionette.View({onFoo: this.methodHandler1, onBar: this.methodHandler2});
this.view.triggerMethod('foo bar');
});

it('should trigger the events', function() {
expect(this.methodHandler1).to.have.been.calledOnce;
expect(this.methodHandler2).to.have.been.calledOnce;
});
});

Expand All @@ -28,21 +41,21 @@ describe('trigger event and method name', function() {
this.view = new Marionette.View();
this.triggerMethodSpy = this.sinon.spy(this.view, 'triggerMethod');

this.view.onFoo = this.methodHandler;
this.view.on('foo', this.eventHandler);
this.view.onFoo = this.methodHandler1;
this.view.on('foo', this.eventHandler1);
this.view.triggerMethod('foo');
});

it('should trigger the event', function() {
expect(this.eventHandler).to.have.been.calledOnce;
expect(this.eventHandler1).to.have.been.calledOnce;
});

it('should call a method named on{Event}', function() {
expect(this.methodHandler).to.have.been.calledOnce;
expect(this.methodHandler1).to.have.been.calledOnce;
});

it('returns the value returned by the on{Event} method', function() {
expect(this.triggerMethodSpy).to.have.been.calledOnce.and.returned(this.returnValue);
expect(this.triggerMethodSpy).to.have.been.calledOnce.and.returned(this.returnValue1);
});

describe('when trigger does not exist', function() {
Expand All @@ -56,91 +69,199 @@ describe('trigger event and method name', function() {
});
});

describe('when triggering events', function() {
beforeEach(function() {
this.view = new Marionette.View();
this.triggerMethodSpy = this.sinon.spy(this.view, 'triggerMethod');

this.view.onFoo = this.methodHandler1;
this.view.on('foo', this.eventHandler1);
this.view.onBar = this.methodHandler2;
this.view.on('bar', this.eventHandler2);
this.view.triggerMethod('foo bar');
});

it('should trigger the event', function() {
expect(this.eventHandler1).to.have.been.calledOnce;
expect(this.eventHandler2).to.have.been.calledOnce;
});

it('should call a method named on{Event}', function() {
expect(this.methodHandler1).to.have.been.calledOnce;
expect(this.methodHandler2).to.have.been.calledOnce;
});

it('returns the value returned by the on{Event} method', function() {
expect(this.triggerMethodSpy).to.have.been.calledOnce.and.returned([this.returnValue1, this.returnValue2]);
});

describe('when trigger does not exist', function() {
beforeEach(function() {
this.triggerNonExistantEvent = _.partial(this.view.triggerMethod, 'does:not:exist1 does:not:exist2');
});

it('should do nothing', function() {
expect(this.triggerNonExistantEvent).not.to.throw;
});
});
});

describe('when triggering an event with arguments', function() {
beforeEach(function() {
this.view = new Marionette.View();
this.view.onFoo = this.methodHandler;
this.view.on('foo', this.eventHandler);
this.view.onFoo = this.methodHandler1;
this.view.on('foo', this.eventHandler1);
this.view.triggerMethod('foo', this.argumentOne, this.argumentTwo);
});

it('should trigger the event with the args', function() {
expect(this.eventHandler).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
expect(this.eventHandler1).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
});

it('should call a method named on{Event} with the args', function() {
expect(this.methodHandler).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
expect(this.methodHandler1).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
});
});

describe('when triggering events with arguments', function() {
beforeEach(function() {
this.view = new Marionette.View();
this.view.onFoo = this.methodHandler1;
this.view.onBar = this.methodHandler2;
this.view.on('foo', this.eventHandler1);
this.view.on('bar', this.eventHandler2);
this.view.triggerMethod('foo bar', this.argumentOne, this.argumentTwo);
});

it('should trigger the events with the args', function() {
expect(this.eventHandler1).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
expect(this.eventHandler2).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
});

it('should call methods named on{Event} with the args', function() {
expect(this.methodHandler1).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
expect(this.methodHandler2).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
});
});

describe('when triggering an event with : separated name', function() {
beforeEach(function() {
this.view = new Marionette.View();
this.view.onFooBar = this.methodHandler;
this.view.on('foo:bar', this.eventHandler);
this.view.onFooBar = this.methodHandler1;
this.view.on('foo:bar', this.eventHandler1);
this.view.triggerMethod('foo:bar', this.argumentOne, this.argumentTwo);
});

it('should trigger the event with the args', function() {
expect(this.eventHandler).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
expect(this.eventHandler1).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
});

it('should call a method named with each segment of the event name capitalized', function() {
expect(this.methodHandler).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
expect(this.methodHandler1).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
});
});

describe('when triggering events with : separated name', function() {
beforeEach(function() {
this.view = new Marionette.View();
this.view.onFooBar = this.methodHandler1;
this.view.onBarFoo = this.methodHandler2;
this.view.on('foo:bar', this.eventHandler1);
this.view.on('bar:foo', this.eventHandler2);
this.view.triggerMethod('foo:bar bar:foo', this.argumentOne, this.argumentTwo);
});

it('should trigger the events with the args', function() {
expect(this.eventHandler1).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
expect(this.eventHandler2).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
});

it('should call methods named with each segment of the event name capitalized', function() {
expect(this.methodHandler1).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
expect(this.methodHandler2).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
});
});

describe('when triggering an event and no handler method exists', function() {
beforeEach(function() {
this.view = new Marionette.View();
this.view.on('foo:bar', this.eventHandler);
this.view.on('foo:bar', this.eventHandler1);
this.view.triggerMethod('foo:bar', this.argumentOne, this.argumentTwo);
});

it('should trigger the event with the args', function() {
expect(this.eventHandler).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
expect(this.eventHandler1).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
});

it('should not call a method named with each segment of the event name capitalized', function() {
expect(this.methodHandler).not.to.have.been.calledOnce;
expect(this.methodHandler1).not.to.have.been.calledOnce;
});
});

describe('when triggering events and no handler method exists', function() {
beforeEach(function() {
this.view = new Marionette.View();
this.view.on('foo:bar', this.eventHandler1);
this.view.on('bar:foo', this.eventHandler2);
this.view.triggerMethod('foo:bar bar:foo', this.argumentOne, this.argumentTwo);
});

it('should trigger the events with the args', function() {
expect(this.eventHandler1).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
expect(this.eventHandler2).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
});

it('should not call methods named with each segment of the event name capitalized', function() {
expect(this.methodHandler1).not.to.have.been.calledOnce;
expect(this.methodHandler2).not.to.have.been.calledOnce;
});
});

describe('when triggering an event and the attribute for that event is not a function', function() {
beforeEach(function() {
this.view = new Marionette.View();
this.view.onFooBar = 'baz';
this.view.on('foo:bar', this.eventHandler);
this.view.triggerMethod('foo:bar', this.argumentOne, this.argumentTwo);
this.view.onBarFoo = 'bax';
this.view.on('foo:bar', this.eventHandler1);
this.view.on('bar:foo', this.eventHandler2);
this.view.triggerMethod('foo:bar bar:foo', this.argumentOne, this.argumentTwo);
});

it('should trigger the event with the args', function() {
expect(this.eventHandler).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
it('should trigger the events with the args', function() {
expect(this.eventHandler1).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
expect(this.eventHandler2).to.have.been.calledOnce.and.calledWith(this.argumentOne, this.argumentTwo);
});

it('should not call a method named with each segment of the event name capitalized', function() {
expect(this.methodHandler).not.to.have.been.calledOnce;
it('should not call methods named with each segment of the event name capitalized', function() {
expect(this.methodHandler1).not.to.have.been.calledOnce;
expect(this.methodHandler2).not.to.have.been.calledOnce;
});
});

describe('triggering events through a child view', function() {
beforeEach(function() {
this.onChildviewFooClickStub = this.sinon.stub();
this.onChildviewBarClickStub = this.sinon.stub();

this.View = Marionette.View.extend({
template: _.template('foo'),
triggers: {'click': 'foo:click'}
triggers: {
'click': 'foo:click bar:click'
}
});

this.CollectionView = Marionette.CollectionView.extend({
childView: this.View,
onChildviewFooClick: this.onChildviewFooClickStub
onChildviewFooClick: this.onChildviewFooClickStub,
onChildviewBarClick: this.onChildviewBarClickStub
});

this.collection = new Backbone.Collection([{foo: 'bar'}]);
this.collectionView = new this.CollectionView({
collection: this.collection
});
this.collection = new Backbone.Collection([
{
foo: 'bar'
}
]);
this.collectionView = new this.CollectionView({collection: this.collection});

this.collectionView.render();
this.childView = this.collectionView.children.findByModel(this.collection.at(0));
Expand All @@ -149,6 +270,7 @@ describe('trigger event and method name', function() {

it('should fire the event method once', function() {
expect(this.onChildviewFooClickStub).to.have.been.calledOnce;
expect(this.onChildviewBarClickStub).to.have.been.calledOnce;
});
});
});