Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rjz/backbone.associate
Presumptionless model relations in < 1kb
https://github.com/rjz/backbone.associate
Last synced: about 2 months ago
JSON representation
Presumptionless model relations in < 1kb
- Host: GitHub
- URL: https://github.com/rjz/backbone.associate
- Owner: rjz
- License: mit
- Created: 2013-02-07T15:00:08.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2018-01-23T05:17:32.000Z (almost 7 years ago)
- Last Synced: 2024-11-02T00:50:23.864Z (about 2 months ago)
- Language: JavaScript
- Homepage:
- Size: 156 KB
- Stars: 36
- Watchers: 4
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Backbone.associate
==================
Presumptionless model relations for Backbone in < 1kb.
[](https://travis-ci.org/rjz/backbone-associate)
[](https://coveralls.io/r/rjz/backbone.associate?branch=master)
## Usage
Use `Backbone.associate` to define relationships between application models and
collections.
```js
var Flag = Backbone.Model.Extend({ /* ... */ }),
City = Backbone.Model.Extend({ /* ... */ }),
Cities = Backbone.Collection.extend({ model: City }),
Country = Backbone.Model.Extend({ /* ... */ });
Backbone.associate(Country, {
flag: { type: Flag },
cities: { type: Cities, url: '/cities' }
});
```
Here, we're associating a model (`Country`) with two relations: a `Flag` model
and a collection of `Cities`. The association keys can be anything, but they
should match the keys used in the data that will be passed into the
application's `parse` method.
```js
var canada = new Country({
url: '/countries/canada',
flag: {
colors: ['red','white']
},
cities: [
{ name: 'Calgary' },
{ name: 'Regina' }
]
});
```
When it's time to sync the parent resource back up with the server, child
resources can be serialized and included in the request.
```js
canada.toJSON(); // { flag: { colors: ['red','white'] }, ...
```
Since associates are *just attributes*, they may be accessed at any time using
the usual `get`.
```js
// GET /countries/canada/cities
canada.get('cities').fetch();
```
For the truly lazy, `associate` provides a convenient accessor for each
association:
```js
canada.flag().set({ colors: ['red','white'] });
canada.cities().add([
{ name: 'Edmonton' },
{ name: 'Montreal' },
{ name: 'Ottawa' },
{ name: 'Vancouver' }
]);
```
That's handy for manipulating the relations, setting up eventing, or any of the
many other things this plugin won't do for you. Speaking of which,
## Things this plugin won't do...
...include making any but the most basic presumptions about how it will be used.
Fortunately, all of these can be implemented as needed ([fiddle
here](http://jsfiddle.net/rjzaworski/79T94/)):
#### Identity mapping
```js
var getCountry = function (id) {
_countries = {};
return (getCountry = function (id) {
if (!_countries[id]) {
_countries[id] = new Country({ id : id });
}
return _countries[id];
})(id);
};
```
#### Child events
```js
canada.onCityAdded = function (model) {
console.log('city added!', model.get('name'));
}
canada.listenTo(canada.cities(), 'add', canada.onCityAdded);
```
## Testing
Specs are implemented with `jasmine-node`. After cloning this repo, install
dependencies and test with npm.
$ npm install
$ npm test
## Related projects
Looking for a more fully-featured alternative? Check out:
* [Backbone.Relational](https://github.com/PaulUithol/Backbone-relational)
* [Supermodel](https://github.com/pathable/supermodel)
## License
Backbone.associate is released under the terms of the MIT license