limeapps / ember-share

Ember persistence and collaboration

EmberShare

EmberShare is an Ember persistence library that utilizes ShareJS, a robust Operational Transforms backend server. It takes care of keeping models consistent, in addition to providing collaborative editing capabilities.

Building:

grunt build-release

How to use:

• Include the the version of the library most suitable for your project from the /dist forlder
• Inject the store into the application

App.initializer({
  name: 'injectStore',
  initialize: function(container, application) {
	application.register('store:main',EmberShare.Store);
    application.inject('controller', 'store', 'store:main');
    application.inject('route', 'store', 'store:main');
  }
});

• For your models you can extend either ShareProxy or ShareArray.

var ItemModel = EmberShare.ShareProxy.extend({
	id: null	// only add id or any non-persistant properties
});

Testing:

grunt test         # headless testing

Contribution:

• Have a look at the issues, we post any challenges/todo items there.
• Help us identify shortcomings via submitting issues.
• We think there is a need for a node module/library to go along with ShareJS in the backend to allow for aspects like Access Control that are needed and are not part of ShareJS.

Dependencies:

• ShareJS
• BrowserChannel or Primus

ember-share's Issues

Access Control

Currently ShareJS focuses on providing robust operational transforms, and does not handle other aspects like Access Control. It does however provide hooks to allow for that.
One way to tackle that is to create a node module/library which utilizes those hooks and allow for more possibilites.

Handle updating a subDoc path when an array changes

Currently ShareProxy properties have a share subDocument under _context. each subDoc has a _path array which identifies its location within the share document. as explained here. Currently when array operations happen the share document gets updated, while subDocs path do not causing the to have invalid indices. There is code in place to correct update a ShareArray own elements but it doesn't update elements further down the tree if any.
tl;dr
need robust updating of paths.

Offline-ready

Are there any plans to make Ember Share offline-ready and have it sync when a network connection is available?

Utilize the websocket connection

It might be useful to utilize the websocket connection to do non-ShareJS api calls, which is usually handled via ajax. Primus has plugins for multiplexing that allow for splitting of the socket connection.

Is it a good idea?