orizens / backbone.safe

a plugin for backbone models to save & load data using localstorage as well

Backbone.Safe - local storage plugin

Backbone.Safe is a plugin for Backbone.js which stores a model's or a collection's json data to the local storage on set operations, regardless server side existance. The concept for Backbone.Safe has been created while the developing the Echoes Player project.

Install

Using Bower:

bower install backbone.safe

Usage

The latest update to Backbone.Safe allows one to define safe with a non distructive definition using a key as such:

var UserProfile = Backbone.Model.extend({
	safe: {
		key: 'myAppUserSafe',
		reload: false
	},
 
	initialize: function() {
		// some statements;
		this.safe.reload()
	},
 
	fetchRoles: function() {
		// some statements;
	}
});
var user = new UserProfile();
 
console.log( user.safe );

With this method, when Safe is not present, the model/collection still functions as expected.

On the other hand, Safe can defined using a factory method as such:

var HistoryPlaylist = Backbone.Collection.extend({
	model: someModel,

	initialize: function() {
		Backbone.Safe.create('historyPlaylist', this);
	},

	queue: function(youtubeJSON) {
		this.add(youtubeJSON);
	}
});
var myPlaylist = new HistoryPlaylist();

console.log( myPlaylist.safe );

Useful Information

1. Currently supports only one level of models/collections.
2. For Model: listens to a 'change' events and stores the data.
3. For Collection: listens to 'add', 'reset' events and stores data.
4. The 'create' function creates a new instance of Backbone.Safe in the 'safe' property

backbone.safe's Issues

collection doesn't store json objects as expected

add option to exclude keys from storage

should be:

safe: {
  key: 'somekey',
  // exclude one or more multiple values
  exclude: 'displayTitle displayTime'
}

Documentation on restoring from localstorage

Hi Oren, thanks for great plugin!

Please adivce how to restore saved models and collections from localstorage with your plugin? If you could provide sample code I will be glad to write the docs =)

Potential Error on Line 179

I noticed that you are using "this.uniqueID" in your destroy method instead of "this.uid". Any reason why? I had to change it to "this.uid" to get it to destroy/remove what was in localstorage.

My use case is below:

add storage QUOTA error message

should handle when local storage is full.

Safe not working correctly for Backbone Collections

I am trying to use the Backbone.Safe from a Backbone.Collection but the Backbone.Safe does not appear to function correctly (I get a item in my collection, after a safe.reload(), when it should be empty).

It looks like then 'isCollection' value is not being determined correctly and as a result the code is treating my collection as a model.

I've modified the code as follows and the Backbone.Safe then works as expected :-

// this.isCollection = !context.set && context.models && context.add;
this.isCollection = ((typeof context.add === 'function') && context.models!=null);

How does this compare to Backbone.LocalStorage

Hi,

Given the other LocalStorage Backbone plugin - https://github.com/jeromegn/Backbone.localStorage

Does Safe offer the same thing or handle a different use case?

Thanks, Chris

change safe methods to Model & Collection methods

stop using:

this.safe.load();

use:

this.fetch('safe');

License Type?