update documentation/name for syncCollection, and add callback

Author: DaftMonk

app/templates/client/app/main/main.controller(coffee).coffee

@@ -3,7 +3,7 @@
 angular.module('<%= scriptAppName %>').controller 'MainCtrl', ($scope, $http<% if(filters.socketio) { %>, socket<% } %>) ->
   $http.get('/api/things').success (awesomeThings) ->
     $scope.awesomeThings = awesomeThings
-    <% if(filters.socketio) { %>socket.syncCollection $scope.awesomeThings, 'thing'<% } %>
+    <% if(filters.socketio) { %>socket.syncArray $scope.awesomeThings, 'thing'<% } %>
 <% if(filters.mongoose) { %>
   $scope.addThing = ->
     return if $scope.newThing is ''

app/templates/client/app/main/main.controller(js).js

@@ -4,7 +4,7 @@ angular.module('<%= scriptAppName %>')
   .controller('MainCtrl', function ($scope, $http<% if(filters.socketio) { %>, socket<% } %>) {
     $http.get('/api/things').success(function(awesomeThings) {
       $scope.awesomeThings = awesomeThings;<% if(filters.socketio) { %>
-      socket.syncCollection($scope.awesomeThings, 'thing');<% } %>
+      socket.syncArray($scope.awesomeThings, 'thing');<% } %>
     });
 <% if(filters.mongoose) { %>
     $scope.addThing = function() {

app/templates/client/components/socket(socketio)/socket.mock(coffee).coffee

@@ -10,4 +10,4 @@ angular.module('socketMock', []).factory 'socket', ->
 
     receive: ->
 
-  syncCollection: ->
+  syncArray: ->

app/templates/client/components/socket(socketio)/socket.mock.js

@@ -10,6 +10,6 @@ angular.module('socketMock', [])
         receive: function() {}
       },
 
-      syncCollection: function() {}
+      syncArray: function() {}
     };
   });

app/templates/client/components/socket(socketio)/socket.service(coffee).coffee

@@ -19,31 +19,43 @@ angular.module('<%= scriptAppName %>').factory 'socket', (socketFactory) ->
   , retryInterval)
   socket = socketFactory(ioSocket: ioSocket)
   socket: socket
-  
+
   ###
-  Register listeners to sync a collection with socket.io
+  Register listeners to sync an array with a database collection through socket.io
+
+  Takes the array we want to sync, the model namespace that socket updates are sent from,
+  and an optional callback function after new items are updated.
+
+  @param {Array} array
+  @param {String} namespace
+  @param {Function} cb
   ###
-  syncCollection: (collection, itemName) ->
-    
+  syncArray: (array, namespace, cb) ->
+    cb = cb or angular.noop
+
     ###
     Syncs item creation/updates on 'model:save'
     ###
-    socket.on itemName + ':save', (newItem) ->
-      oldItem = _.find(collection,
+    socket.on namespace + ":save", (newItem) ->
+      oldItem = _.find(array,
         _id: newItem._id
       )
-      index = collection.indexOf(oldItem)
-      
+      index = array.indexOf(oldItem)
+
       # replace oldItem if it exists
       # otherwise just add newItem to the collection
       if oldItem
-        collection.splice index, 1, newItem
+        array.splice index, 1, newItem
       else
-        collection.push newItem
-    
+        array.push newItem
+      cb array
+
+
     ###
     Syncs removed items on 'model:remove'
     ###
-    socket.on itemName + ':remove', (newItem) ->
-      _.remove collection,
-        _id: newItem._id
+    socket.on namespace + ":remove", (newItem) ->
+      _.remove array,
+        _id: newItem._id
+
+      cb array

app/templates/client/components/socket(socketio)/socket.service.js

@@ -35,31 +35,42 @@ angular.module('<%= scriptAppName %>')
       socket: socket,
 
       /**
-       * Register listeners to sync a collection with socket.io
+       * Register listeners to sync an array with a database collection through socket.io
+       *
+       * Takes the array we want to sync, the model namespace that socket updates are sent from,
+       * and an optional callback function after new items are updated.
+       *
+       * @param {Array} array
+       * @param {String} namespace
+       * @param {Function} cb
        */
-      syncCollection: function(collection, itemName) {
+      syncArray: function(array, namespace, cb) {
+        cb = cb || angular.noop;
 
         /**
          * Syncs item creation/updates on 'model:save'
          */
-        socket.on(itemName + ':save', function(newItem) {
-          var oldItem = _.find(collection, { _id: newItem._id });
-          var index = collection.indexOf(oldItem);
+        socket.on(namespace + ':save', function(newItem) {
+          var oldItem = _.find(array, { _id: newItem._id });
+          var index = array.indexOf(oldItem);
 
           // replace oldItem if it exists
           // otherwise just add newItem to the collection
           if(oldItem) {
-            collection.splice(index, 1, newItem);
+            array.splice(index, 1, newItem);
           } else {
-            collection.push(newItem);
+            array.push(newItem);
           }
+
+          cb(array)
         });
 
         /**
          * Syncs removed items on 'model:remove'
          */
-        socket.on(itemName + ':remove', function(newItem) {
-          _.remove(collection, { _id: newItem._id });
+        socket.on(namespace + ':remove', function(newItem) {
+          _.remove(array, { _id: newItem._id });
+          cb(array)
         });
       }
     };