Source code
Revision control
Copy as Markdown
Other Tools
# jasmine-flight [](http://travis-ci.org/flightjs/jasmine-flight)
# Getting started
Include [jasmine-flight.js](https://raw.github.com/flightjs/jasmine-flight/master/lib/jasmine-flight.js)
in your app and load it in your test runner.
```bash
bower install --save-dev jasmine-flight
```
**N.B.** jasmine-flight depends on
## Components
```javascript
describeComponent('path/to/component', function () {
beforeEach(function () {
setupComponent();
});
it('should do x', function () {
// a component instance is now accessible as this.component
// the component root node is attached to the DOM
// the component root node is also available as this.$node
});
});
```
## Mixins
```javascript
describeMixin('path/to/mixin', function () {
// initialize the component and attach it to the DOM
beforeEach(function () {
setupComponent();
});
it('should do x', function () {
expect(this.component.doSomething()).toBe(expected);
});
});
```
## Event spy
```javascript
describeComponent('data/twitter_profile', function () {
beforeEach(function () {
setupComponent();
});
describe('listens for uiNeedsTwitterUserId', function () {
// was the event triggered?
it('and triggers dataTwitterUserId', function () {
var eventSpy = spyOnEvent(document, 'dataTwitterProfile');
$(document).trigger('uiNeedsTwitterUserId', {
screen_name: 'tbrd'
});
expect(eventSpy).toHaveBeenTriggeredOn(document);
});
// is the user id correct?
it('and has correct id', function () {
var eventSpy = spyOnEvent(document, 'dataTwitterUserId');
$(document).trigger('uiNeedsTwitteruserId', {
screen_name: 'tbrd'
});
expect(eventSpy.mostRecentCall.data).toEqual({
screen_name: 'tbrd',
id: 4149861
});
});
});
});
```
## setupComponent
```javascript
setupComponent(optionalFixture, optionalOptions);
```
Calling `setupComponent` twice will create an instance, tear it down and create a new one.
### HTML Fixtures
```javascript
describeComponent('ui/twitter_profile', function () {
// is the component attached to the fixture?
it('this.component.$node has class "foo"', function () {
setupComponent('<span class="foo">Test</span>');
expect(this.component.$node).toHaveClass('foo');
});
});
```
### Component Options
```javascript
describeComponent('data/twitter_profile', function () {
// is the option set correctly?
it('this.component.attr.baseUrl is set', function () {
setupComponent({
});
});
});
```
# Teardown
Components are automatically torn down after each test.
## Contributing to this project
Anyone and everyone is welcome to contribute. Please take a moment to
review the [guidelines for contributing](CONTRIBUTING.md).
* [Bug reports](CONTRIBUTING.md#bugs)
* [Feature requests](CONTRIBUTING.md#features)
* [Pull requests](CONTRIBUTING.md#pull-requests)
## Authors
## Thanks
`describeComponent` & `describeMixin` methods.
## License
Copyright 2013 Twitter, Inc and other contributors.
Licensed under the MIT License