cleaned up source comments

Author: John Doherty

lib/node-iframe-replacement.js

@@ -5,10 +5,9 @@ var cheerio = require('cheerio'),           // used to convert raw html into jQu
     NodeCache = require( "node-cache" ),    // auto expiring in memory caching collection
     cache = new NodeCache({ stdTTL: 300 }); // cache source HTML for 5 minutes, after which we fetch a new version
 
-// override res.render to allow us to fetch template url or use html template string
 module.exports = function(req, res, next){
-    
-    // replace the standard res.render function so we can intercept response rendering
+
+    // add res.merge to response object to allow us to fetch template url or use html template string    
     res.merge = function(view, model, callback){
 
         if (!model.sourceUrl){
@@ -45,6 +44,7 @@ module.exports = function(req, res, next){
 
                     // if the view has a body, use its contents otherwise use the entire content 
                     var $viewBody = $view('body');
+
                     if ($viewBody && $viewBody.length>0){
                         // inject content into selector or body
                         $template(sourcePlaceholder).html($viewBody.html());    
@@ -70,50 +70,50 @@ module.exports = function(req, res, next){
 
 /**
  * Converts template url to $ object 
- * @param {string} template - url to external template or html content
+ * @param {string} sourceUrl - url to external template or html content
  */
-function resolveTemplate(template){
+function resolveTemplate(sourceUrl){
 
     return new Promise(function(resolve, reject){
 
         // if its a url and we have the contents in cache
-        if (template.isUrl() && cache.get(template)){
+        if (sourceUrl.isUrl() && cache.get(sourceUrl)){
 
-            // get template html from cache
-            var html = cache.get(template);
+            // get source html from cache
+            var html = cache.get(sourceUrl);
 
             // covert html into jquery object
             var $ = cheerio.load(html);
 
-            // return template as a jquery style object
+            // return source as a jquery style object
             resolve($);
         }
-        else if (template.isUrl()){
+        else if (sourceUrl.isUrl()){
 
-            // request the template url
-            return request({ uri: template }).then(function(html){
+            // request the source url
+            return request({ uri: sourceUrl }).then(function(html){
 
                 // convert html into jquery style object so we can use selectors
                 var $ = cheerio.load(html);
 
-                // add base url to ensure links/scripts/styles load correctly
-                $('head').prepend('<base href="' + template + '">');
+                // insert base tag to ensure links/scripts/styles load correctly
+                $('head').prepend('<base href="' + sourceUrl + '">');
 
                 // cache result as HTML so we dont have to keep getting it for future requests and it remains clean
-                cache.set(template, $.html());
+                cache.set(sourceUrl, $.html());
 
                 // resolve with jquery object containing content
                 resolve($);
             })
             .catch(function(err) {
 
                 // request failed
-                reject('Unable to retrieve ' + template);
+                reject('Unable to retrieve ' + sourceUrl);
             });
         }
         else {
-            // the template must contain markup, just return it
-            resolve(template);
+            // the sourceUrl must contain markup, just return it
+            resolve(sourceUrl);
         }
     });
 }