backbone-rels

Backbone one-to-one, one-to-many, and many-to-many relationships for the browser and nodejs.

Install

npm install backbone-rels

Use

Check out the test models for examples. Basically...

Rels = require 'backbone-rels'

You can optionally bind Rels to your own Backbone instance (rather than the stock one) like so...

Backbone = require 'backbone'
Rels = require('backbone-rels') Backbone

You'll want to do this if you've overridden methods on Backbone, like sync, for example, and you want to maintain proper inheritance. This is not an issue in the browser, however.

Once you have a Rels reference...

class MyModel extends BackboneRels.Model
  rels:
    modelA:
      hasOne: ModelA
      myFk: 'modelAId'
    modelBs:
      hasMany: ModelB
      theirFk: 'myModelId'
    modelCs:
      hasMany: ModelC
      via: JoinModel
      myViaFk: 'myModelId'
      theirViaFk: 'modelCId'
class MyModel.Collection extends BackboneRels.Collection
  model: MyModel
  url: '/my-models'

With this structure in place, you can now do this...

myModel = MyModel.new()
modelA = ModelA.new()
myModel.set.modelA modelA
myModel.get 'modelAId' # modelA.id 
myModel.get.modelA # modelA 
myModel.get.modelBs # ModelB.Collection 
myModel.get.modelCs # ModelC.Collection 
myModel.get.modelCs.via # JoinModel.Collection 
myModel.get.modelCs.add ModelC.new()
myModel.get.modelCs.length # 1 
myModel.get.modelCs.via.length # 1 

Check out the tests for more examples.

Test

make test

Licence

Copyright (C) 2012 Casey Foster [e-mail]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.