From e5e1f173ab02abe31050aaaf2465f48959310f05 Mon Sep 17 00:00:00 2001
From: Michael Ball <cycomachead@gmail.com>
Date: Fri, 13 Mar 2015 11:37:00 -0700
Subject: [PATCH] Fix #862 - Sorts Help Commands by Script
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This changes @commands from [] → {} which keeps track of each script
as they are loaded. Then `helpCommands` returns an array after calling
sort() on the commands of each script, rather than all scripts at once.

Note that this means that the command `hubot help <TERM>` will show
commands sorted by script still, since the filtering is done in the help
script. A simple solution would be to have the help scripts call sort()
after filtering, but this, of course, wouldn't be applied to existing
installations.
---
 src/robot.coffee | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/src/robot.coffee b/src/robot.coffee
index ae0f15964..16234734e 100644
--- a/src/robot.coffee
+++ b/src/robot.coffee
@@ -45,7 +45,7 @@ class Robot
     @alias     = false
     @adapter   = null
     @Response  = Response
-    @commands  = []
+    @commands  = {}
     @listeners = []
     @logger    = new Log process.env.HUBOT_LOG_LEVEL or 'info'
     @pingIntervalId = null
@@ -343,7 +343,10 @@ class Robot
   #
   # Returns an Array of help commands for running scripts.
   helpCommands: ->
-    @commands.sort()
+    output = []
+    for script, cmds of @commands
+      output = output.concat(cmds.sort())
+    return output
 
   # Private: load help info from a loaded script.
   #
@@ -354,7 +357,7 @@ class Robot
     @logger.debug "Parsing help for #{path}"
     scriptName = Path.basename(path).replace /\.(coffee|js)$/, ''
     scriptDocumentation = {}
-
+    @commands[scriptName] = []
     body = Fs.readFileSync path, 'utf-8'
 
     currentSection = null
@@ -374,7 +377,7 @@ class Robot
         if currentSection
           scriptDocumentation[currentSection].push cleanedLine.trim()
           if currentSection is 'commands'
-            @commands.push cleanedLine.trim()
+            @commands[scriptName].push cleanedLine.trim()
 
     if currentSection is null
       @logger.info "#{path} is using deprecated documentation syntax"
@@ -384,7 +387,7 @@ class Robot
         continue if not line.match('-')
         cleanedLine = line[2..line.length].replace(/^hubot/i, @name).trim()
         scriptDocumentation.commands.push cleanedLine
-        @commands.push cleanedLine
+        @commands[scriptName].push cleanedLine
 
   # Public: A helper send function which delegates to the adapter's send
   # function.