command_line.rb in ronin-0.3.0

- old
+ new

@@ -1,9 +1,7 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -16,11 +14,10 @@
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-#++
 #
 
 require 'ronin/ui/command_line/exceptions/unknown_command'
 
 require 'reverse_require'
@@ -34,49 +31,67 @@
 
       # Name of the default to run
       DEFAULT_COMMAND = 'console'
 
       #
-      # Returns the commands registered with the command-line utility.
+      # All command-line names of Commands available to the CommandLine.
       #
+      # @return [Array]
+      #   The command-line names of available Command classes.
+      #
       def CommandLine.commands
         unless class_variable_defined?('@@ronin_commands')
           pattern = File.join('lib',COMMANDS_DIR,'*.rb')
-          paths = Gem.find_resources(pattern)
-          
-          @@ronin_commands = []
-            
-          paths.each do |path|
-            name = File.basename(path).gsub(/\.rb$/,'')
 
-            @@ronin_commands << name unless @@ronin_commands.include?(name)
-          end
+          @@ronin_commands = Gem.find_resources(pattern).map { |path|
+            File.basename(path).gsub(/\.rb$/,'')
+          }.uniq
         end
 
         return @@ronin_commands
       end
 
       #
-      # Returns +true+ if a command exists with the specified _name_,
-      # returns +false+ otherwise.
+      # Searches for the command with the matching name.
       #
+      # @param [String, Symbol] name
+      #   The name of the command to search for.
+      #
+      # @return [Boolean]
+      #   Specifies whether a command exists with the matching name.
+      #
       def CommandLine.has_command?(name)
         CommandLine.commands.include?(name.to_s)
       end
 
       #
-      # Returns the Command registered with the command-line utility
-      # with the specified _name_.
+      # Searches for a Command class with the matching command-line name.
       #
+      # @param [String, Symbol] name
+      #   The command-line name of the command to search for.
+      #
+      # @return [Ronin::UI::Command]
+      #   The Command registered with the command-line utility with the
+      #   matching command-line _name_.
+      #
+      # @raise [UnknownCommand]
+      #   No valid command could be found or loaded with the matching
+      #   command-line _name_.
+      #
+      # @example
       #   CommandLine.get_command('gen_overlay')
       #   # => Ronin::UI::CommandLine::Commands::GenOverlay
       #
+      # @example
+      #   CommandLine.get_command('gen-overlay')
+      #   # => Ronin::UI::CommandLine::Commands::GenOverlay
+      #
       def CommandLine.get_command(name)
         name = name.to_s
 
-        #eventually someone is going to use a space or - which is going mess things up
-        #we will take care of this ahead of time here
+        # eventually someone is going to use a space or - which is going
+        # mess things up we will take care of this ahead of time here
         name.gsub!(/[\s-]/, '_')
 
         begin
           require File.join(COMMANDS_DIR,name)
         rescue Gem::LoadError => e
@@ -91,32 +106,40 @@
           raise(UnknownCommand,"unknown command #{name.dump}",caller)
         end
 
         command = Commands.const_get(class_name)
 
-        unless command.respond_to?(:run)
-          raise(UnknownCommand,"command #{name.dump} must provide a 'run' method",caller)
+        unless command.respond_to?(:start)
+          raise(UnknownCommand,"command #{name.dump} must provide a 'start' method",caller)
         end
 
         return command
       end
 
       #
-      # Runs the command-line utility with the given _argv_ Array. If the
-      # first argument is a sub-command name, the command-line utility will
-      # attempt to find and execute the Command with the same name.
+      # Runs the CommandLine utility. If the first argument is a Command
+      # name, the CommandLine utility will attempt to find and run
+      # the Command with the matching command-line name. If the first
+      # argument is an option, or there are no arguments, the
+      # +DEFAULT_COMMAND+ will be ran.
       #
-      def CommandLine.run(*argv)
-        if (argv.empty? || argv.first[0..0]=='-')
+      # @param [Array] argv
+      #   Command-line arguments which are used to select the Command to
+      #   run, and which will be passed to the Command.
+      #
+      # @return [true]
+      #   The command was successfully ran.
+      #
+      def CommandLine.start(argv=ARGV)
+        if (argv.empty? || argv.first[0,1]=='-')
           name = DEFAULT_COMMAND
-          argv = ARGV
         else
           name = argv.first
           argv = argv[1..-1]
         end
 
         begin
-          CommandLine.get_command(name).run(*argv)
+          CommandLine.get_command(name).start(argv)
         rescue UnknownCommand => e
           STDERR.puts e
           exit -1
         end
 