entangled 0.0.21 → 0.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a57bb2d361ca6fc01d21e41081913491ec6d3f96
-  data.tar.gz: 8e76dffbad36c6d4f5ce3189852c054d919bbe36
+  metadata.gz: 0a2db62264a96d90447e75a73bed98ef29fd1a86
+  data.tar.gz: 5e2a82bd5418bb9911b54febe96721e285cee439
 SHA512:
-  metadata.gz: 313a25571895c0076d87989f4efae4cda3d8642255fa930844b02306b12f2dca7d6d5d5236ca8778d64588a5f55e8f555fc2c44a9d9155e1276e0f7b57339a99
-  data.tar.gz: 0fd5d35de6ee95bdb9f77b1a21df7959b17e19048dcd19e6bea3794ebb9e1980cf4c22ff589a51320fca923c08bf01d55a471531083b51a0f60a59a8f7a2d0c1
+  metadata.gz: a4ce644d5222adcf7a7631da195c64ea1f35c9e70419451ece36a3a46325adca6c7386d015b70e10610f3d0d484c95fca19648f624f7baf9f4d02283ade87147
+  data.tar.gz: 31dfde1c1a38423af73029c115b38580030d2c268104b4ce5b90ea305c059458d1622e024267a81476f74880d9c7a07af2e0420e2ced2b4b33a55064b8aafe35

data/README.md

@@ -97,7 +97,7 @@ You can limit this behavior by specifying `:only` or `:except` options. For exam
 
 ```ruby
 entangle only: :create
-entangled only: [:create, :update]
+entangle only: [:create, :update]
 ```
 
 ### Controllers
@@ -134,7 +134,7 @@ class MessagesController < ApplicationController
 
   def destroy
     broadcast do
-      Message.find(params[:id]).destroy
+      @message = Message.find(params[:id]).destroy
     end
   end
 
@@ -148,9 +148,9 @@ end
 Note the following:
 
 - All methods are wrapped in a new `broadcast` block needed to receive and send data to connected clients
-- The `index` method will expect an instance variable with the same name as your controller in the plural form (e.g. `@messages` in a `MessagesController`)
-- The `show`, `create` and `update` methods will expect an instance variable with the singular name of your controller (e.g. `@message` in a `MessagesController`)
-- Data sent to clients arrives as stringified JSON
+- The `index` action will expect an instance variable with the same name as your controller in the plural form (e.g. `@messages` in a `MessagesController`)
+- The `show`, `create`, `update`, and `destroy` actions will expect an instance variable with the singular name of your controller (e.g. `@message` in a `MessagesController`)
+- The instance variables are sent to clients as stringified JSON
 - Strong parameters are expected
 
 ### Server
@@ -299,6 +299,14 @@ $scope.message.$save(function() {
 
 Note that `$valid()` and `$invalid()` should only be used after $saving a resource, i.e. in the callback of `$save`, since they don't actually invoke server side validations. They only check if a resource contains errors.
 
+#### Persistence
+Just as with ActiveRecord's `persisted?` method, you can use `$persisted()` on an object to check if it was successfully stored in the database.
+
+```javascript
+$scope.message.$persisted();
+// => true or false
+```
+
 #### Associations
 What if you want to only fetch and subscribe to children that belong to a specific parent? Or maybe you want to create a child in your front end and assign it to a specific parent?
 
@@ -361,12 +369,12 @@ end
 ```javascript
 app.factory('Parent', function(Entangled) {
   // Instantiate Entangled service
-  var entangled = new Entangled('ws://localhost:3000/parents');
+  var Parent = new Entangled('ws://localhost:3000/parents');
 
   // Set up association  
-  entangled.hasMany('children');
+  Parent.hasMany('children');
 
-  return entangled;
+  return Parent;
 });
 ```
 
@@ -394,14 +402,6 @@ This is the way to go if you want to fetch records that only belong to a certain
 
 Naturally, all nested records are also synced in real time across all connected clients.
 
-#### Persistence
-Just as with ActiveRecord's `persisted?` method, you can use `$persisted()` on an object to check if it was successfully stored in the database.
-
-```javascript
-$scope.message.$persisted();
-// => true or false
-```
-
 ## Planning Your Infrastructure
 This gem is best used for Rails apps that serve as APIs only and are not concerned with rendering views, since Entangled controllers cannot render views. A front end separate from your Rails app is recommended, either in your Rails app's public directory, or a separate front end app altogether.
 
@@ -411,13 +411,22 @@ The gem relies heavily on convention over configuration and currently only works
 ## Development Priorities
 The following features are to be implemented next:
 
-- Offline capabilities - when client is disconnected, put websocket interactions in a queue and dequeue all once connected again
-- Support for authentication
-- Support for associations
-- On Heroku (maybe in production in general), objects are always in different order depending on their attributes
-- Add $onChange listener to objects
+- Support more than one belongs_to association in back end
+- Support belongs_to in front end
+- Support deeply nested belongs_to, e.g. Parent > Child > Grandchild
+- Support has_one association in back end and front end
+- Add offline capabilities
+- Add authentication - with JWT?
+- On Heroku, tasks are always in different order depending on which ones are checked off and not
+- Add $onChange function to objects - or could a simple $watch and $watchCollection suffice?
 - Add diagram on how it works to Readme
 - Check if Rails 4.0.0 supported too
+- GNU instead of MIT? Or something else? How to switch?
+- Contact Jessy to tweet about it!
+- Handle errors gracefully (e.g. finding a non-existent id, etc, authorization error in the back end, timeouts, etc)
+- Test controllers (see https://github.com/ngauthier/tubesock/issues/41)
+- Freeze destroyed object
+- Set $persisted() to false on a destroyed object
 
 ## Contributing
 1. [Fork it](https://github.com/dchacke/entangled/fork) - you will notice that the repo comes with a back end and a front end part to test both parts of the gem

data/bower.json

@@ -1,6 +1,6 @@
 {
   "name": "entangled",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "authors": [
     "Dennis Charles Hackethal <dennis.hackethal@gmail.com>"
   ],

data/entangled.js

@@ -1 +1 @@
-angular.module("entangled",[]).factory("Entangled",function(){var e=function(e,t,r){for(var o in e)e.hasOwnProperty(o)&&(this[o]=e[o]);this.webSocketUrl=t,r&&(this[r]=function(){return new s(this.webSocketUrl+"/"+this.id+"/"+r)})};e.prototype.$save=function(e){if(this.id){var t=new WebSocket(this.webSocketUrl+"/"+this.id+"/update");t.onopen=function(){t.send(JSON.stringify(this))}.bind(this),t.onmessage=function(t){if(t.data){var r=JSON.parse(t.data);if(r.resource)for(key in r.resource)this[key]=r.resource[key]}this[this.hasMany]=new s(this.webSocketUrl+"/"+this.id+"/"+this.hasMany),e&&e(this)}.bind(this)}else{var t=new WebSocket(this.webSocketUrl+"/create");t.onopen=function(){t.send(JSON.stringify(this))}.bind(this),t.onmessage=function(t){if(t.data){var s=JSON.parse(t.data);if(s.resource)for(key in s.resource)this[key]=s.resource[key]}e&&e(this)}.bind(this)}},e.prototype.$update=function(e,t){for(var s in e)e.hasOwnProperty(s)&&(this[s]=e[s]);this.$save(t)},e.prototype.$destroy=function(e){var t=new WebSocket(this.webSocketUrl+"/"+this.id+"/destroy");t.onopen=function(){t.send(null),e&&e()}},e.prototype.$valid=function(){return!(this.errors&&Object.keys(this.errors).length)},e.prototype.$invalid=function(){return!this.$valid()},e.prototype.$persisted=function(){return!!this.id};var t=function(t,s,r){this.all=[];for(var o=0;o<t.length;o++){var i=new e(t[o],s,r);this.all.push(i)}},s=function(e){this.webSocketUrl=e};return s.prototype.hasMany=function(e){this.hasMany=e},s.prototype["new"]=function(t){return new e(t,this.webSocketUrl,this.hasMany)},s.prototype.all=function(s){var r=new WebSocket(this.webSocketUrl);r.onmessage=function(o){if(o.data.length){var i=JSON.parse(o.data);if(i.resources)this.resources=new t(i.resources,r.url,this.hasMany);else if(i.action)if("create"===i.action)this.resources.all.push(new e(i.resource,r.url,this.hasMany));else if("update"===i.action){for(var n,a=0;a<this.resources.all.length;a++)this.resources.all[a].id===i.resource.id&&(n=a);this.resources.all[n]=new e(i.resource,r.url,this.hasMany)}else if("destroy"===i.action){for(var n,a=0;a<this.resources.all.length;a++)this.resources.all[a].id===i.resource.id&&(n=a);this.resources.all.splice(n,1)}else console.log("Something else other than CRUD happened..."),console.log(i)}s(this.resources.all)}.bind(this)},s.prototype.create=function(e,t){var s=this["new"](e);s.$save(t)},s.prototype.find=function(t,s){var r=this.webSocketUrl,o=new WebSocket(r+"/"+t);o.onmessage=function(t){if(t.data.length){var o=JSON.parse(t.data);o.resource&&!o.action?this.resource=new e(o.resource,r,this.hasMany):o.action?"update"===o.action?this.resource=new e(o.resource,r,this.hasMany):"destroy"===o.action&&(this.resource=void 0):(console.log("Something else other than CRUD happened..."),console.log(o))}s(this.resource)}.bind(this)},s});
+angular.module("entangled",[]).factory("Entangled",function(){var e=function(e,t,r){for(var i in e)e.hasOwnProperty(i)&&(this[i]=e[i]);this.webSocketUrl=t,r&&(this[r]=function(){return new s(this.webSocketUrl+"/"+this.id+"/"+r)})};e.prototype.$save=function(e){if(this.id){var t=new WebSocket(this.webSocketUrl+"/"+this.id+"/update");t.onopen=function(){t.send(JSON.stringify(this))}.bind(this),t.onmessage=function(t){if(t.data){var r=JSON.parse(t.data);if(r.resource)for(key in r.resource)this[key]=r.resource[key]}this[this.hasMany]=new s(this.webSocketUrl+"/"+this.id+"/"+this.hasMany),e&&e(this)}.bind(this)}else{var t=new WebSocket(this.webSocketUrl+"/create");t.onopen=function(){t.send(JSON.stringify(this))}.bind(this),t.onmessage=function(t){if(t.data){var s=JSON.parse(t.data);if(s.resource)for(key in s.resource)this[key]=s.resource[key]}e&&e(this)}.bind(this)}},e.prototype.$update=function(e,t){for(var s in e)e.hasOwnProperty(s)&&(this[s]=e[s]);this.$save(t)},e.prototype.$destroy=function(e){var t=new WebSocket(this.webSocketUrl+"/"+this.id+"/destroy");t.onopen=function(){t.send(null)},t.onmessage=function(t){if(t.data){var s=JSON.parse(t.data);if(s.resource)for(key in s.resource)this[key]=s.resource[key]}e&&e(this)}.bind(this)},e.prototype.$valid=function(){return!(this.errors&&Object.keys(this.errors).length)},e.prototype.$invalid=function(){return!this.$valid()},e.prototype.$persisted=function(){return!!this.id};var t=function(t,s,r){this.all=[];for(var i=0;i<t.length;i++){var o=new e(t[i],s,r);this.all.push(o)}},s=function(e){this.webSocketUrl=e};return s.prototype.hasMany=function(e){this.hasMany=e},s.prototype["new"]=function(t){return new e(t,this.webSocketUrl,this.hasMany)},s.prototype.all=function(s){var r=new WebSocket(this.webSocketUrl);r.onmessage=function(i){if(i.data.length){var o=JSON.parse(i.data);if(o.resources)this.resources=new t(o.resources,r.url,this.hasMany);else if(o.action)if("create"===o.action)this.resources.all.push(new e(o.resource,r.url,this.hasMany));else if("update"===o.action){for(var n,a=0;a<this.resources.all.length;a++)this.resources.all[a].id===o.resource.id&&(n=a);this.resources.all[n]=new e(o.resource,r.url,this.hasMany)}else if("destroy"===o.action){for(var n,a=0;a<this.resources.all.length;a++)this.resources.all[a].id===o.resource.id&&(n=a);this.resources.all.splice(n,1)}else console.log("Something else other than CRUD happened..."),console.log(o)}s(this.resources.all)}.bind(this)},s.prototype.create=function(e,t){var s=this["new"](e);s.$save(t)},s.prototype.find=function(t,s){var r=this.webSocketUrl,i=new WebSocket(r+"/"+t);i.onmessage=function(t){if(t.data.length){var i=JSON.parse(t.data);i.resource&&!i.action?this.resource=new e(i.resource,r,this.hasMany):i.action?"update"===i.action?this.resource=new e(i.resource,r,this.hasMany):"destroy"===i.action&&(this.resource=void 0):(console.log("Something else other than CRUD happened..."),console.log(i))}s(this.resource)}.bind(this)},s});

data/lib/entangled/controller.rb

@@ -193,10 +193,23 @@ module Entangled
               close_db_connection
             end
 
+          when 'destroy'
+            tubesock.onmessage do |m|
+              yield
+
+              # Send resource that was just destroyed back to client
+              if member
+                tubesock.send_data({
+                  resource: member
+                }.to_json)
+              end
+
+              close_db_connection
+            end
+
           # For every other controller action, simply wrap whatever is
           # yielded in the tubesock block to execute it in the context
-          # of the socket. The delete action is automatically covered
-          # by this, and other custom action can be added through this.
+          # of the socket. Other custom actions can be added through this
           else
             tubesock.onmessage do |m|
               yield

data/lib/entangled/version.rb

@@ -1,3 +1,3 @@
 module Entangled
-  VERSION = "0.0.21"
+  VERSION = "0.0.22"
 end

data/spec/dummy/app/controllers/items_controller.rb

@@ -28,7 +28,7 @@ class ItemsController < ApplicationController
 
   def destroy
     broadcast do
-      Item.find(params[:id]).destroy
+      @item = Item.find(params[:id]).destroy
     end
   end
 

data/spec/dummy/app/controllers/lists_controller.rb

@@ -21,7 +21,7 @@ class ListsController < ApplicationController
 
   def destroy
     broadcast do
-      List.find(params[:id]).destroy
+      @list = List.find(params[:id]).destroy
     end
   end
 

data/spec/dummy/app/controllers/messages_controller.rb

@@ -30,7 +30,7 @@ class MessagesController < ApplicationController
 
   def destroy
     broadcast do
-      Message.find(params[:id]).destroy
+      @message = Message.find(params[:id]).destroy
     end
   end
 

data/spec/dummy/public/app/controllers/list.js

@@ -11,6 +11,21 @@ angular.module('entangledTest')
           $scope.items = items;
         });
       });
+
+      $scope.item = $scope.list.items().new();
+      console.log($scope.item);
     });
   });
+
+  $scope.createItem = function() {
+    $scope.item.$save(function() {
+      $scope.$apply(function() {
+        $scope.item = $scope.list.items().new();
+      });
+    });
+  };
+
+  $scope.updateItem = function(event, item) {
+    item.$save();
+  };
 });

data/spec/dummy/public/app/entangled/entangled.js

@@ -6,7 +6,7 @@ angular.module('entangled', [])
   // Every response coming from the server will be wrapped
   // in a Resource constructor to represent a CRUD-able
   // resource that can be saved and destroyed using the
-  // methods $save() and $destroy. A Resource also
+  // methods $save(), $destroy, and others. A Resource also
   // stores the socket's URL it was retrieved from so it
   // can be reused for other requests.
   var Resource = function(params, webSocketUrl, hasMany) {
@@ -114,14 +114,28 @@ angular.module('entangled', [])
   // destroy an existing record.
   Resource.prototype.$destroy = function(callback) {
     var socket = new WebSocket(this.webSocketUrl + '/' + this.id + '/destroy');
+
     socket.onopen = function() {
       // It's fine to send an empty message since the
       // socket's URL contains all the information
       // needed to destroy the record (the id).
       socket.send(null);
-
-      if (callback) callback();
     };
+
+    socket.onmessage = function(event) {
+      if (event.data) {
+        var data = JSON.parse(event.data);
+
+        // Assign/override new data
+        if (data.resource) {
+          for (key in data.resource) {
+            this[key] = data.resource[key];
+          }
+        }
+      }
+
+      if (callback) callback(this);
+    }.bind(this);
   };
 
   // $valid() checks if any errors are attached to the object
@@ -174,7 +188,6 @@ angular.module('entangled', [])
   // sets up websockets accordingly
   Entangled.prototype.hasMany = function(resources) {
     this.hasMany = resources;
-    // this[resources] = new Entangled(this.webSocketUrl + '/' + this.id + '/' + resources);
   };
 
   // Function to instantiate a new Resource, optionally

data/spec/dummy/public/index.html

@@ -5,6 +5,7 @@
 <body>
   <h1>Hello, young programmer!</h1>
   <div ng-view=""></div>
+  <a href="#/lists">Lists</a>
   <script src="bower_components/angular/angular.js"></script>
   <script src="bower_components/angular-route/angular-route.js"></script>
   <script src="app/entangled/entangled.js"></script>

data/spec/dummy/public/test/controllers/messages_test.js

@@ -161,7 +161,7 @@ describe('MessagesCtrl', function () {
     expect(message.$valid()).toBeTruthy();
   });
 
-  it('checks for validity with $invalid()', function() {
+  it('checks for invalidity with $invalid()', function() {
     var message = Message.new();
 
     // Message should not be invalid without errors
@@ -201,6 +201,17 @@ describe('MessagesCtrl', function () {
     }, 100);
   });
 
+  it('can destroy a message and receives it in the callback', function(done) {
+    Message.create({ body: 'foo' }, function(message) {
+      expect(message.$persisted()).toBeTruthy();
+
+      message.$destroy(function(message) {
+        expect(message).toBeDefined();
+        done();
+      });
+    });
+  });
+
   it('can check for persistence', function() {
     // Instantiate record and mimic persistence
     var message = Message.new({ id: 1 });

data/spec/dummy/public/views/lists/show.html

@@ -2,8 +2,15 @@
 
 <h2>{{ list.name }}</h2>
 
-<ul>
-  <li ng-repeat="item in items">
-    {{ item.name }}, {{ item.complete }}
-  </li>
-</ul>
+<table>
+  <tr ng-repeat="item in items">
+    <td>{{ item.name }}</td>
+    <td><input ng-model="item.complete" type="checkbox" ng-checked="item.complete" ng-change="updateItem($event, item)"></td>
+  </tr>
+</table>
+
+<h4>Add item to this list</h4>
+<form ng-submit="createItem()">
+  <input ng-model="item.name">
+  <input type="submit">
+</form>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: entangled
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.0.22
 platform: ruby
 authors:
 - Dennis Charles Hackethal