Adds onReady hook to Spiderable package

Resolves #3824
Adds missing `DDP` dependancy
Adds `callback-hook` for onReady hook registration
Adds some client tests for `Spiderable`
Bumps version to `1.0.8`

packages/spiderable/package.js

@@ -1,10 +1,12 @@
 Package.describe({
   summary: "Makes the application crawlable to web spiders",
-  version: "1.0.7"
+  version: "1.0.8"
 });
 
 Package.onUse(function (api) {
   api.use('webapp', 'server');
+  api.use(['ddp'], 'client');
+  api.use(['callback-hook'], 'client');
   api.use(['templating'], 'client');
   api.use(['underscore'], ['client', 'server']);
 
@@ -20,5 +22,6 @@ Package.onUse(function (api) {
 
 Package.onTest(function (api) {
   api.use(['spiderable', 'tinytest']);
-  api.addFiles('spiderable_tests.js', 'server');
+  api.addFiles('spiderable_client_tests.js', 'client');
+  api.addFiles('spiderable_server_tests.js', 'server');
 });

packages/spiderable/phantom_script.js

@@ -10,12 +10,10 @@ var isReady = function () {
     }
     if (typeof Package === 'undefined'
         || Package.spiderable === undefined
-        || Package.spiderable.Spiderable === undefined
-        || !Package.spiderable.Spiderable._initialSubscriptionsStarted) {
+        || Package.spiderable.Spiderable === undefined) {
       return false;
     }
-    Tracker.flush();
-    return DDP._allSubscriptionsReady();
+    return Package.spiderable.Spiderable.isReady();
   });
 };
 

packages/spiderable/spiderable_client.js

@@ -17,14 +17,52 @@
 
 Spiderable._initialSubscriptionsStarted = false;
 
+Spiderable._onReadyHook = new Hook({
+  debugPrintExceptions: "onReadyHook callback"
+});
+
+// register a new onReady hook for validation
+Spiderable.onReady = function (fn) {
+  var self = this;
+  return self._onReadyHook.register(fn);
+};
+
+//
+// register default hooks
+
+// top level code ready
+Spiderable.onReady(function(){
+  // subs & top level code (startup) completed
+  return Spiderable._initialSubscriptionsStarted;
+})
 var startupCallbacksDone = function () {
   Spiderable._initialSubscriptionsStarted = true;
 };
-
 // This extra indirection is how we get called last
 var topLevelCodeDone = function () {
   // We'd like to use Meteor.startup here I think, but docs/behaviour of that is wrong
   Meteor._setImmediate(function () { startupCallbacksDone(); });
 };
-
 Meteor.startup(function () { topLevelCodeDone(); });
+
+// all ddp subs ready
+Spiderable.onReady(function(){
+  Tracker.flush();
+  return DDP._allSubscriptionsReady();
+})
+
+// run all hooks and return true if they all pass
+Spiderable.isReady = function(){
+  var self = this;
+  var isReady = true;
+  self._onReadyHook.each(function (callback) {
+    if (callback()){
+      return true; // next callback
+    } else {
+      isReady = false;
+      return false; // stop immediately
+    }
+  });
+  return isReady;
+};
+

packages/spiderable/spiderable_client_tests.js

@@ -0,0 +1,84 @@
+Tinytest.add("spiderable - default hooks registered", function (test, expect) {
+  test.equal(
+    _.keys(Spiderable._onReadyHook.callbacks).length,
+    2
+  );
+});
+
+Tinytest.add("spiderable - is not ready while initial subscriptions aren't started", function (test, expect) {
+  Spiderable._initialSubscriptionsStarted = false;
+  test.equal(
+    Spiderable.isReady(),
+    false
+  );
+});
+
+Tinytest.add("spiderable - is not ready while DDP Subscriptions aren't ready", function (test, expect) {
+  original = DDP._allSubscriptionsReady;
+
+  Spiderable._initialSubscriptionsStarted = true;
+  DDP._allSubscriptionsReady = function(){return false};
+
+  test.equal(
+    Spiderable.isReady(),
+    false
+  );
+
+  // restore original
+  DDP._allSubscriptionsReady = original;
+});
+
+Tinytest.add("spiderable - default hooks can ready", function (test, expect) {
+  original = DDP._allSubscriptionsReady;
+
+  Spiderable._initialSubscriptionsStarted = true;
+  DDP._allSubscriptionsReady = function(){return true};
+
+  test.equal(
+    Spiderable.isReady(),
+    true
+  );
+
+  // restore original
+  DDP._allSubscriptionsReady = original;
+});
+
+Tinytest.add("spiderable - is not ready with a custom hook", function (test, expect) {
+  //clear all callbacks
+  _.each(Spiderable._onReadyHook.callbacks, function(value,key,list){
+    delete list[key];
+  });
+
+  test.equal(
+    _.keys(Spiderable._onReadyHook.callbacks).length,
+    0
+  );
+
+  Spiderable.onReady(function(){
+    return false;
+  });
+  test.equal(
+    Spiderable.isReady(),
+    false
+  );
+});
+
+Tinytest.add("spiderable - is ready with a custom hook", function (test, expect) {
+  //clear all callbacks
+  _.each(Spiderable._onReadyHook.callbacks, function(value,key,list){
+    delete list[key];
+  });
+
+  test.equal(
+    _.keys(Spiderable._onReadyHook.callbacks).length,
+    0
+  );
+
+  Spiderable.onReady(function(){
+    return true;
+  });
+  test.equal(
+    Spiderable.isReady(),
+    true
+  );
+});