lib/gitlab/help.rb in gitlab-3.5.0 vs lib/gitlab/help.rb in gitlab-3.6.0

@@ -3,21 +3,20 @@
 
 module Gitlab::Help
   extend Gitlab::CLI::Helpers
 
   class << self
-
     # Returns the (modified) help from the 'ri' command or returns an error.
     #
     # @return [String]
     def get_help(cmd)
       cmd_namespace = namespace cmd
 
       if cmd_namespace
         ri_output = `#{ri_cmd} -T #{cmd_namespace} 2>&1`.chomp
 
-        if $? == 0
+        if $CHILD_STATUS == 0
           change_help_output! cmd, ri_output
           yield ri_output if block_given?
 
           ri_output
         else
@@ -32,11 +31,11 @@
     #
     # @return [String]
     def ri_cmd
       which_ri = `which ri`.chomp
       if which_ri.empty?
-        raise "'ri' tool not found in $PATH. Please install it to use the help."
+        fail "'ri' tool not found in $PATH. Please install it to use the help."
       end
 
       which_ri
     end
 
@@ -45,23 +44,23 @@
     # branches, protect_branch, etc.).
     #
     # @return [Hash<Array>]
     def help_map
       @help_map ||= begin
-          actions.each_with_object({}) do |action, hsh|
-            key = client.method(action).
-                         owner.to_s.gsub(/Gitlab::(?:Client::)?/, '')
-            hsh[key] ||= []
-            hsh[key] << action.to_s
-          end
+        actions.each_with_object({}) do |action, hsh|
+          key = client.method(action).
+                owner.to_s.gsub(/Gitlab::(?:Client::)?/, '')
+          hsh[key] ||= []
+          hsh[key] << action.to_s
+        end
       end
     end
 
     # Table with available commands.
     #
     # @return [Terminal::Table]
-    def actions_table(topic = nil)
+    def actions_table(topic=nil)
       rows = topic ? help_map[topic] : help_map.keys
       table do |t|
         t.title = topic || "Help Topics"
 
         # add_row expects an array and we have strings hence the map.
@@ -73,18 +72,23 @@
     end
 
     # Returns full namespace of a command (e.g. Gitlab::Client::Branches.cmd)
     def namespace(cmd)
       method_owners.select { |method| method[:name] === cmd }.
-                    map    { |method| method[:owner] + '.' + method[:name] }.
-                    shift
+        map { |method| method[:owner] + '.' + method[:name] }.
+        shift
     end
 
     # Massage output from 'ri'.
     def change_help_output!(cmd, output_str)
-      output_str.gsub!(/#{cmd}\((.*?)\)/m, cmd+' \1')
+      output_str.gsub!(/#{cmd}\((.*?)\)/m, cmd + ' \1')
       output_str.gsub!(/\,[\s]*/, ' ')
+      
+      # Ensure @option descriptions are on a single line
+      output_str.gsub!(/\n\[/, " \[")
+      output_str.gsub!(/\s(@)/, "\n@")
+      output_str.gsub!(/(\])\n(\:)/, '\1 \2')
+      output_str.gsub!(/(\:.*)(\n)(.*\.)/, '\1 \3')
+      
     end
-
   end # class << self
 end
-