Miscellaneous controller cleanup

* Remove controllers `.gitignore` as we don't use nodejitsu anymore
* White space adjustment
* Mods won't be editing scripts and user profiles so remove those TODO's
* Comment typo
* One reorder from general to specific

Originally applies to #262 ... not part of #262 (comment)

Author: Martii

controllers/.gitignore

@@ -2,7 +2,7 @@
 
 /*
  * NOTE: This file is used as a general guideline to creating a new controller file.
- *       As the project progressing there may some changes to it.
+ *       As the project progresses there may some changes to it.
  *
  *       Please remember to omit this comment block when creating a new controller file.
  */

controllers/_template.js

@@ -17,6 +17,8 @@ var git = require('git-rev');
 //--- Controller inclusions
 
 //--- Library inclusions
+// var documentLib = require('../libs/document');
+
 var modelParser = require('../libs/modelParser');
 
 var renderMd = require('../libs/markdown').renderMd;
@@ -71,66 +73,62 @@ exports.view = function (aReq, aRes, aNext) {
     //--- Tasks
 
     // Read the requested md file contents
-    tasks.push(
-      function (aCallback) {
-        fs.readFile(documentPath + '/' + document + '.md', 'utf8', function (aErr, aData) {
-          var lines = null;
-          var matches = null;
-          var heading = null;
-          var content = null;
-
-          if (aErr) {
-            aCallback({ statusCode: 404, statusMessage: 'Error retrieving page' });
-            return;
-          }
-
-          // Check if first line is h2 and use for title/heading if present
-          lines = aData.split('\n');
-          matches = lines[0].match(/^##\s(.*)$/);
-          if (matches) {
-            heading = lines.shift().replace(/^##\s+/, "");
-          } else {
-            heading = document;
-          }
-          content = lines.join('\n');
-
-          // Page metadata
-          pageMetadata(options, [heading, 'About']);
-
-          options.pageHeading = heading;
-          options.pageData = renderMd(content);
-
-          aCallback(null);
-        });
-      }
-    );
+    tasks.push(function (aCallback) {
+      fs.readFile(documentPath + '/' + document + '.md', 'utf8', function (aErr, aData) {
+        var lines = null;
+        var matches = null;
+        var heading = null;
+        var content = null;
+
+        if (aErr) {
+          aCallback({ statusCode: 404, statusMessage: 'Error retrieving page' });
+          return;
+        }
+
+        // Check if first line is h2 and use for title/heading if present
+        lines = aData.split('\n');
+        matches = lines[0].match(/^##\s(.*)$/);
+        if (matches) {
+          heading = lines.shift().replace(/^##\s+/, "");
+        } else {
+          heading = document;
+        }
+        content = lines.join('\n');
+
+        // Page metadata
+        pageMetadata(options, [heading, 'About']);
+
+        options.pageHeading = heading;
+        options.pageData = renderMd(content);
+
+        aCallback(null);
+      });
+    });
 
     // Read file listing
-    tasks.push(
-      function (aCallback) {
-        fs.readdir(documentPath, function (aErr, aFileList) {
-          var file = null;
-
-          if (aErr || !aFileList) {
-            aCallback({ statusCode: 500, statusMessage : 'Error retrieving page list' });
-            return;
-          }
-
-          // Dynamically create a file listing of the pages
-          options.fileList = [];
-          for (file in aFileList) {
-            if (/\.md$/.test(aFileList[file])) {
-              options.fileList.push({
-                href: aFileList[file].replace(/\.md$/, ''),
-                textContent: aFileList[file].replace(/\.md$/, '').replace(/-/g, ' ')
-              });
-            }
+    tasks.push(function (aCallback) {
+      fs.readdir(documentPath, function (aErr, aFileList) {
+        var file = null;
+
+        if (aErr || !aFileList) {
+          aCallback({ statusCode: 500, statusMessage : 'Error retrieving page list' });
+          return;
+        }
+
+        // Dynamically create a file listing of the pages
+        options.fileList = [];
+        for (file in aFileList) {
+          if (/\.md$/.test(aFileList[file])) {
+            options.fileList.push({
+              href: aFileList[file].replace(/\.md$/, ''),
+              textContent: aFileList[file].replace(/\.md$/, '').replace(/-/g, ' ')
+            });
           }
+        }
 
-          aCallback(null);
-        });
-      }
-    );
+        aCallback(null);
+      });
+    });
   }
   else {
     // Page metadata
@@ -169,16 +167,13 @@ exports.view = function (aReq, aRes, aNext) {
     //--- Tasks
 
     // Read git short hash HEAD for current tree
-    tasks.push(
-
-      function (aCallback) {
-        git.short(function (aStr) {
-          options.git.short = aStr;
+    tasks.push(function (aCallback) {
+      git.short(function (aStr) {
+        options.git.short = aStr;
 
-          aCallback(null);
-        });
-      }
-    );
+        aCallback(null);
+      });
+    });
 
     // Read git branch name of current tree
     tasks.push(

controllers/document.js

@@ -21,13 +21,13 @@ var scriptStorage = require('./scriptStorage');
 
 //--- Library inclusions
 var flagLib = require('../libs/flag');
+
 var statusCodePage = require('../libs/templateHelpers').statusCodePage;
 
 //--- Configuration inclusions
 
 //---
 
-
 // Controller to flag and unflag content
 exports.flag = function (aReq, aRes, aNext) {
   var form = null;

controllers/flag.js

@@ -38,6 +38,7 @@ var pageMetadata = require('../libs/templateHelpers').pageMetadata;
 
 //--- Configuration inclusions
 var htmlWhitelistLink = require('../libs/htmlWhitelistLink.json');
+
 var removeReasons = require('../views/includes/scriptModals.json').removeReasons;
 
 //---
@@ -299,7 +300,6 @@ var setupScriptSidePanel = function (aOptions) {
 
   // Mod
   if (authedUser && authedUser.isMod) {
-    //aOptions.authorTools = {}; // TODO: Support moderator edits on scripts?
     aOptions.modTools = {};
 
     if (removeReasons) {

controllers/script.js

@@ -22,12 +22,13 @@ var User = require('../models/user').User;
 var Discussion = require('../models/discussion').Discussion;
 
 //--- Controller inclusions
+var scriptStorage = require('./scriptStorage');
+
 var categories = require('./discussion').categories;
 var getFlaggedListForContent = require('./flag').getFlaggedListForContent;
-var scriptStorage = require('./scriptStorage');
 
 //--- Library inclusions
-//var userLib = require('../libs/user');
+// var userLib = require('../libs/user');
 
 var helpers = require('../libs/helpers');
 
@@ -150,7 +151,6 @@ var setupUserSidePanel = function (aOptions) {
 
   // Mod
   if (authedUser && authedUser.isMod && (authedUser.role < user.role || aOptions.isYou)) {
-    //aOptions.userTools = {}; // TODO: Support moderator edits of user profiles?
     aOptions.modTools = {};
 
     if (removeReasons) {