rprogram 0.1.7 → 0.1.8

data/History.txt

@@ -1,3 +1,12 @@
+=== 0.1.8 / 2009-12-24
+ 
+* Allow Program to run commands under sudo:
+  * Added Compat.sudo.
+  * Added Task#sudo.
+  * Added Task#sudo=.
+  * Added Task#sudo?.
+  * Added Program#sudo.
+
 === 0.1.7 / 2009-09-21
 
 * Require Hoe >= 2.3.3.

data/Manifest.txt

@@ -25,6 +25,8 @@ lib/rprogram/yard/handlers/ruby.rb
 lib/rprogram/yard/handlers/ruby/metaclass_eval_handler.rb
 lib/rprogram/yard/handlers/ruby/legacy.rb
 lib/rprogram/yard/handlers/ruby/legacy/metaclass_eval_handler.rb
+tasks/spec.rb
+tasks/yard.rb
 spec/spec_helper.rb
 spec/classes/named_program.rb
 spec/classes/aliased_program.rb

data/README.txt

@@ -15,15 +15,12 @@ system.
 
 * Uses Kernel.system for safe execution of individual programs and their
   separate command-line arguments.
+* Allows running programs under +sudo+.
 * Provides cross-platform access to the PATH variable.
 * Supports leading/tailing non-options.
 * Supports long-options and short-options.
 * Supports custom formating of options.
 
-== REQUIREMENTS:
-
-* {YARD}[http://yard.soen.ca/] >= 0.2.3.5
-  
 == INSTALL:
 
   $ sudo gem install rprogram

data/Rakefile

@@ -11,12 +11,9 @@ Hoe.spec('rprogram') do
   self.developer('Postmodern', 'postmodern.mod3@gmail.com')
   self.remote_rdoc_dir = ''
 
-  self.extra_deps = [
-    ['yard', '>=0.2.3.5']
-  ]
-
   self.extra_dev_deps = [
-    ['rspec', '>=1.2.8']
+    ['rspec', '>=1.2.8'],
+    ['yard', '>=0.5.2']
   ]
 
   self.spec_extras = {:has_rdoc => 'yard'}

data/lib/rprogram/compat.rb

@@ -1,9 +1,12 @@
+require 'rprogram/exceptions/program_not_found'
+
 module RProgram
   module Compat
     #
     # Determines the native platform.
     #
-    # @return [String] The native platform.
+    # @return [String]
+    #   The native platform.
     #
     # @example
     #   Compat.arch  #=> "linux"
@@ -15,7 +18,8 @@ module RProgram
     #
     # Determines the contents of the +PATH+ environment variable.
     #
-    # @return [Array] The contents of the +PATH+ environment variable.
+    # @return [Array]
+    #   The contents of the +PATH+ environment variable.
     #
     # @example
     #   Compat.paths #=> ["/bin", "/usr/bin"]
@@ -35,9 +39,11 @@ module RProgram
     #
     # Finds the full-path of the program with the matching name.
     #
-    # @param [String] name The name of the program to find.
+    # @param [String] name
+    #   The name of the program to find.
     #
-    # @return [String, nil] The full-path of the desired program.
+    # @return [String, nil]
+    #   The full-path of the desired program.
     #
     # @example
     #   Compat.find_program('as')  #=> "/usr/bin/as"
@@ -55,10 +61,11 @@ module RProgram
     #
     # Finds the program matching one of the matching names.
     #
-    # @param [Array] names The names of the program to use while
-    #                      searching for the program.
+    # @param [Array] names
+    #   The names of the program to use while searching for the program.
     #
-    # @return [String, nil] The first full-path for the program.
+    # @return [String, nil]
+    #   The first full-path for the program.
     #
     # @example
     #   Compat.find_program_by_names("gas","as")  #=> "/usr/bin/as"
@@ -66,5 +73,54 @@ module RProgram
     def Compat.find_program_by_names(*names)
       names.map { |name| Compat.find_program(name) }.compact.first
     end
+
+    #
+    # Runs a program.
+    #
+    # @param [String] path
+    #   The path to the program.
+    #
+    # @param [Array] args
+    #   Additional arguments to run the program with.
+    #
+    # @return [Boolean]
+    #   Specifies whether the program exited successfully.
+    #
+    def Compat.run(path,*args)
+      args = args.map { |arg| arg.to_s }
+
+      if RProgram.debug
+        STDERR.puts ">>> #{path} #{args.join(' ')}"
+      end
+
+      return Kernel.system(path,*args)
+    end
+
+    #
+    # Runs a program under sudo.
+    #
+    # @param [String] path
+    #   Path of the program to run.
+    #
+    # @param [Array] args
+    #   Additional arguments to run the program with.
+    #
+    # @return [Boolean]
+    #   Specifies whether the program exited successfully.
+    #
+    # @raise [ProgramNotFound]
+    #   Indicates that the +sudo+ program could not be located.
+    #
+    # @since 0.1.8
+    #
+    def Compat.sudo(path,*args)
+      sudo_path = Compat.find_program('sudo')
+
+      unless sudo_path
+        raise(ProgramNotFound,'could not find the "sudo" program',caller)
+      end
+
+      return Compat.run(sudo_path,path,*args)
+    end
   end
 end

data/lib/rprogram/nameable.rb

@@ -6,14 +6,16 @@ module RProgram
     def self.included(base)
       base.metaclass_eval do
         #
-        # @return [String] The name of the program.
+        # @return [String]
+        #   The name of the program.
         #
         def program_name
           @program_name ||= nil
         end
 
         #
-        # @return [Array] The program's aliases.
+        # @return [Array]
+        #   The program's aliases.
         #
         def program_aliases
           @program_aliases ||= []
@@ -22,7 +24,8 @@ module RProgram
         #
         # Combines program_name with program_aliases.
         #
-        # @return [Array] Names the program is known by.
+        # @return [Array]
+        #   Names the program is known by.
         #
         def program_names
           ([program_name] + program_aliases).compact
@@ -31,7 +34,8 @@ module RProgram
         #
         # Sets the program name for the class.
         #
-        # @param [String, Symbol] name The new program name.
+        # @param [String, Symbol] name
+        #   The new program name.
         #
         # @example
         #   name_program 'ls'
@@ -43,7 +47,8 @@ module RProgram
         #
         # Sets the program aliases for the class.
         #
-        # @param [Array] aliases The new program aliases.
+        # @param [Array] aliases
+        #   The new program aliases.
         #
         # @example
         #   alias_program 'vim', 'vi'
@@ -55,21 +60,24 @@ module RProgram
     end
 
     #
-    # @return [String] The program name of the class.
+    # @return [String]
+    #   The program name of the class.
     #
     def program_name
       self.class.program_name
     end
 
     #
-    # @return [Array] The program aliases of the class.
+    # @return [Array]
+    #   The program aliases of the class.
     #
     def program_aliases
       self.class.program_aliases
     end
 
     #
-    # @return [Array] The program names of the class.
+    # @return [Array]
+    #   The program names of the class.
     #
     def program_names
       self.class.program_names

data/lib/rprogram/non_option.rb

@@ -10,17 +10,20 @@ module RProgram
     #
     # Creates a new NonOption object.
     #
-    # @param [Hash] options Additional options.
-    # @option options [Symbol] :name The name of the non-option.
+    # @param [Hash] options
+    #   Additional options.
+    #
+    # @option options [Symbol] :name
+    #   The name of the non-option.
+    #
     # @option options [true, false] :leading (true)
-    #                                        Implies the non-option is a
-    #                                        leading non-option.
+    #   Implies the non-option is a leading non-option.
+    #
     # @option options [false, true] :tailing (false)
-    #                                        Implies the non-option is a
-    #                                        tailing non-option.
+    #   Implies the non-option is a tailing non-option.
+    #
     # @option options [false, true] :multiple (false)
-    #                                         Implies the non-option maybe
-    #                                         given an Array of values.
+    #   Implies the non-option maybe given an Array of values.
     #
     def initialize(options={})
       @name = options[:name]
@@ -39,8 +42,8 @@ module RProgram
     #
     # Determines whether the non-option's arguments are tailing.
     #
-    # @return [true, false] Specifies whether the non-option's arguments are
-    #                       tailing.
+    # @return [true, false]
+    #   Specifies whether the non-option's arguments are tailing.
     #
     def tailing?
       @tailing == true
@@ -49,8 +52,8 @@ module RProgram
     #
     # Determines whether the non-option's arguments are leading.
     #
-    # @return [true, false] Specifies whether the non-option's arguments are
-    #                       leading.
+    # @return [true, false]
+    #   Specifies whether the non-option's arguments are leading.
     #
     def leading?
       !(@tailing)
@@ -59,10 +62,11 @@ module RProgram
     #
     # Formats the arguments for the non-option.
     #
-    # @param [Hash, Array, String, nil] value The value to use for the
-    #                                         arguments of the non-option.
+    # @param [Hash, Array, String, nil] value
+    #   The value to use for the arguments of the non-option.
     #                                   
-    # @return [Array] The arguments for the non-option.
+    # @return [Array]
+    #   The arguments for the non-option.
     #
     def arguments(value)
       return [] unless value

data/lib/rprogram/option.rb

@@ -22,30 +22,35 @@ module RProgram
     # _block_ is not given, the option will use the default_format when
     # generating the arguments.
     #
-    # @param [Hash] options Additional options.
-    # @option options [String] :flag The command-line flag to use.
+    # @param [Hash] options
+    #   Additional options.
+    #
+    # @option options [String] :flag
+    #   The command-line flag to use.
+    #
     # @option options [true, false] :equals (false)
-    #                                       Implies the option maybe
-    #                                       formated as
-    #                                       <tt>"--flag=value"</tt>.
+    #   Implies the option maybe formated as <tt>"--flag=value"</tt>.
     #
     # @option options [true, false] :multiple (false)
-    #                                         Specifies the option maybe
-    #                                         given an Array of values.
-    # @option options [String] :separator The separator to use for
-    #                                     formating multiple arguments into
-    #                                     one +String+. Cannot be used with
-    #                                     the +:multiple+ option.
+    #   Specifies the option maybe given an Array of values.
+    #
+    # @option options [String] :separator
+    #   The separator to use for formating multiple arguments into one
+    #   +String+. Cannot be used with the +:multiple+ option.
+    #
     # @option options [true, false] :sub_options (false)
-    #                                            Specifies that the option
-    #                                            contains sub-options.
+    #   Specifies that the option contains sub-options.
+    #
+    # @yield [option, value]
+    #   If a block is given, it will be used to format each value of the
+    #   option.
+    #
+    # @yieldparam [Option] option
+    #   The option that is being formatted.
     #
-    # @yield [option, value] If a block is given, it will be used to format
-    #                        each value of the option.
-    # @yieldparam [Option] option The option that is being formatted.
-    # @yieldparam [String, Array] value The value to format for the
-    #                                   option. May be an Array, if multiple
-    #                                   values are allowed with the option.
+    # @yieldparam [String, Array] value
+    #   The value to format for the option. May be an Array, if multiple
+    #   values are allowed with the option.
     #
     def initialize(options={},&block)
       @flag = options[:flag]
@@ -75,9 +80,11 @@ module RProgram
     #
     # Formats the arguments for the option.
     #
-    # @param [Hash, Array, String] value The arguments to format.
+    # @param [Hash, Array, String] value
+    #   The arguments to format.
     #
-    # @return [Array] The formatted arguments of the option.
+    # @return [Array]
+    #   The formatted arguments of the option.
     #
     def arguments(value)
       return [@flag] if value == true

data/lib/rprogram/option_list.rb

@@ -4,7 +4,8 @@ module RProgram
     #
     # Creates a new OptionList object.
     #
-    # @param [Hash{Symbol => String}] options The options to start with.
+    # @param [Hash{Symbol => String}] options
+    #   The options to start with.
     #
     def initialize(options={})
       super(options)

data/lib/rprogram/options.rb

@@ -7,7 +7,8 @@ module RProgram
     def self.included(base)
       base.metaclass_eval do
         #
-        # @return [Hash] All defined non-options of the class.
+        # @return [Hash]
+        #   All defined non-options of the class.
         #
         def non_options
           @non_options ||= {}
@@ -17,10 +18,12 @@ module RProgram
         # Searches for the non-option with the matching name in the class
         # and it's ancestors.
         #
-        # @param [Symbol, String] name The name to search for.
+        # @param [Symbol, String] name
+        #   The name to search for.
         #
-        # @return [true, false] Specifies whether the non-option with the
-        #                       matching name was defined.
+        # @return [true, false]
+        #   Specifies whether the non-option with the matching name was
+        #   defined.
         #
         def has_non_option?(name)
           name = name.to_sym
@@ -38,9 +41,11 @@ module RProgram
         # Searches for the non-option with the matching name in the class
         # and it's ancestors.
         #
-        # @param [Symbol, String] name The name to search for.
+        # @param [Symbol, String] name
+        #   The name to search for.
         #
-        # @return [NonOption] The non-option with the matching name.
+        # @return [NonOption]
+        #   The non-option with the matching name.
         #
         def get_non_option(name)
           name = name.to_sym
@@ -57,7 +62,8 @@ module RProgram
         end
 
         #
-        # @return [Hash] All defined options for the class.
+        # @return [Hash]
+        #   All defined options for the class.
         #
         def options
           @options ||= {}
@@ -67,10 +73,11 @@ module RProgram
         # Searches for the option with the matching name in the class and
         # it's ancestors.
         #
-        # @param [Symbol, String] name The name to search for.
+        # @param [Symbol, String] name
+        #   The name to search for.
         #
-        # @return [true, false] Specifies whether the option with the
-        #                       matching name was defined.
+        # @return [true, false]
+        #   Specifies whether the option with the matching name was defined.
         #
         def has_option?(name)
           name = name.to_sym
@@ -88,9 +95,11 @@ module RProgram
         # Searches for the option with the matching name in the class and
         # it's ancestors.
         #
-        # @param [Symbol, String] name The name to search for.
+        # @param [Symbol, String] name
+        #   The name to search for.
         #
-        # @return [Option] The option with the matching name.
+        # @return [Option]
+        #   The option with the matching name.
         #
         def get_option(name)
           name = name.to_sym

data/lib/rprogram/program.rb

@@ -18,14 +18,18 @@ module RProgram
     #
     # Creates a new Program object.
     #
-    # @param [String] path The full-path of the program.
+    # @param [String] path
+    #   The full-path of the program.
     #
-    # @yield [prog] If a block is given, it will be passed the newly
-    #               created Program object.
-    # @yieldparam [Program] prog The newly created program object.
+    # @yield [prog]
+    #   If a block is given, it will be passed the newly created Program
+    #   object.
     #
-    # @raise [ProgramNotFound] Specifies the given path was not a valid
-    #                          file.
+    # @yieldparam [Program] prog
+    #   The newly created program object.
+    #
+    # @raise [ProgramNotFound]
+    #   Specifies the given path was not a valid file.
     #
     # @example
     #   Program.new('/usr/bin/ls')
@@ -46,17 +50,22 @@ module RProgram
     #
     # Creates a new program object.
     #
-    # @param [String] path The full-path of the program.
-    # @param [Array] arguments Additional arguments to initialize the
-    #                          program with.
+    # @param [String] path
+    #   The full-path of the program.
+    #
+    # @param [Array] arguments
+    #   Additional arguments to initialize the program with.
     #
-    # @yield [prog] If a block is given, it will be passed the newly
-    #               created Program object.
-    # @yieldparam [Program] prog The newly created program object.
+    # @yield [prog]
+    #   If a block is given, it will be passed the newly created Program
+    #   object.
     #
-    # @return [Program, nil] Returns the newly created Program object.
-    #                        If the given path was not a valid file,
-    #                        +nil+ will be returned.
+    # @yieldparam [Program] prog
+    #   The newly created program object.
+    #
+    # @return [Program, nil]
+    #   Returns the newly created Program object. If the given path was
+    #   not a valid file, +nil+ will be returned.
     #
     # @example
     #   Program.find_with_path('/bin/cd')
@@ -75,17 +84,22 @@ module RProgram
     # if a path within _paths_ is a valid file. Any given _arguments_ or
     # a given _block_ will be used in creating the new program.
     #
-    # @param [Array] paths The Array of paths to search for the program.
-    # @param [Array] arguments Additional arguments to initialize
-    #                          the program with.
+    # @param [Array] paths
+    #   The Array of paths to search for the program.
+    #
+    # @param [Array] arguments
+    #   Additional arguments to initialize the program with.
     #
-    # @yield [prog] If a block is given, it will be passed the newly
-    #               created Program object.
-    # @yieldparam [Program] prog The newly created program object.
+    # @yield [prog]
+    #   If a block is given, it will be passed the newly created Program
+    #   object.
     #
-    # @return [Program, nil] Returns the newly created Program object.
-    #                        If none of the given paths were valid files,
-    #                        +nil+ will be returned.
+    # @yieldparam [Program] prog
+    #   The newly created program object.
+    #
+    # @return [Program, nil]
+    #   Returns the newly created Program object. If none of the given
+    #   paths were valid files, +nil+ will be returned.
     #
     # @example
     #   Program.find_with_paths(['/bin/cd','/usr/bin/cd'])
@@ -104,17 +118,21 @@ module RProgram
     #
     # Finds and creates the program using it's +program_names+.
     #
-    # @param [Array] arguments Additional arguments to initialize the
-    #                          program object with.
+    # @param [Array] arguments
+    #   Additional arguments to initialize the program object with.
+    #
+    # @yield [prog]
+    #   If a block is given, it will be passed the newly created Program
+    #   object.
     #
-    # @yield [prog] If a block is given, it will be passed the newly
-    #               created Program object.
-    # @yieldparam [Program] prog The newly created program object.
+    # @yieldparam [Program] prog
+    #   The newly created program object.
     #
-    # @return [Program] The newly created program object.
+    # @return [Program]
+    #   The newly created program object.
     #
-    # @raise [ProgramNotFound] Non of the +program_names+ represented
-    #                          valid programs on the system.
+    # @raise [ProgramNotFound]
+    #   Non of the +program_names+ represented valid programs on the system.
     #
     # @example
     #   Program.find
@@ -140,9 +158,11 @@ module RProgram
     #
     # Runs the program.
     #
-    # @param [Array] args Addition arguments to run the program with.
+    # @param [Array] args
+    #   Addition arguments to run the program with.
     #
-    # @return [true, false] Specifies the exit status of the program.
+    # @return [true, false]
+    #   Specifies the exit status of the program.
     #
     # @example
     #   echo = Program.find_by_name('echo')
@@ -153,33 +173,51 @@ module RProgram
     # @see Kernel.system
     #
     def run(*args)
-      args = args.map { |arg| arg.to_s }
-
-      if RProgram.debug
-        STDERR.puts ">>> #{@path} #{args.join(' ')}"
-      end
+      Compat.run(@path,*args)
+    end
 
-      return Kernel.system(@path,*args)
+    #
+    # Runs the program under sudo.
+    #
+    # @param [Array] args
+    #   Additional arguments to run the program with.
+    #
+    # @return [Boolean]
+    #   Specifies whether the program exited successfully.
+    #
+    # @raise [ProgramNotFound]
+    #   Indicates that the +sudo+ program could not be located.
+    #
+    # @since 0.1.8
+    #
+    def sudo(*args)
+      Compat.sudo(@path,*args)
     end
 
     #
     # Runs the program with the arguments from the given task.
     #
-    # @param [Task] task The task who's arguments will be used to run the
-    #                    program.
+    # @param [Task] task
+    #   The task who's arguments will be used to run the program.
     #
-    # @return [true, false] Specifies the exit status of the program.
+    # @return [true, false]
+    #   Specifies the exit status of the program.
     #
     # @see Kernel.system
     #
     def run_task(task)
-      run(*(task.arguments))
+      if task.sudo?
+        return sudo(*(task.arguments))
+      else
+        return run(*(task.arguments))
+      end
     end
 
     #
     # Converts the program to a String.
     #
-    # @return [String] The path of the program.
+    # @return [String]
+    #   The path of the program.
     #
     # @example
     #   Program.find_by_name('echo').to_s

data/lib/rprogram/rprogram.rb

@@ -1,7 +1,8 @@
 module RProgram
   #
-  # @return [true, false] Specifies whether debugging messages are enabled
-  #                       for RProgram. Defaults to false, if not set.
+  # @return [true, false]
+  #   Specifies whether debugging messages are enabled for RProgram.
+  #   Defaults to false, if not set.
   #
   def RProgram.debug
     @@rprogram_debug ||= false
@@ -10,8 +11,11 @@ module RProgram
   #
   # Enables or disables debugging messages for RProgram.
   #
-  # @param [true, false] value The new value of RProgram.debug.
-  # @return [true, false] The new value of RProgram.debug.
+  # @param [true, false] value
+  #   The new value of RProgram.debug.
+  #
+  # @return [true, false]
+  #   The new value of RProgram.debug.
   #
   def RProgram.debug=(value)
     @@rprogram_debug = value

data/lib/rprogram/task.rb

@@ -6,14 +6,20 @@ module RProgram
 
     include Options
 
+    # Specifies whether the task will be run under sudo
+    attr_accessor :sudo
+
     #
     # Creates a new Task object.
     #
-    # @param [Hash{Symbol => Object}] options Additional task options.
+    # @param [Hash{Symbol => Object}] options
+    #   Additional task options.
+    #
+    # @yield [task]
+    #   If a block is given, it will be passed the newly created task.
     #
-    # @yield [task] If a block is given, it will be passed the newly
-    #               created task.
-    # @yieldparam [Task] task The newly created Task object.
+    # @yieldparam [Task] task
+    #   The newly created Task object.
     #
     # @example
     #   Task.new(:test => 'example', :count => 2, :verbose => true)
@@ -24,6 +30,7 @@ module RProgram
     #   end
     #
     def initialize(options={},&block)
+      @sudo = (options.delete(:sudo) || false)
       @subtasks = {}
       @options = options
 
@@ -34,13 +41,17 @@ module RProgram
     # Creates a new Task object, then formats command-line arguments
     # using the Task object.
     #
-    # @param [Hash{Symbol => Object}] options Additional task options.
+    # @param [Hash{Symbol => Object}] options
+    #   Additional task options.
     #
-    # @yield [task] If a block is given, it will be passed the newly
-    #               created task.
-    # @yieldparam [Task] task The newly created Task object.
+    # @yield [task]
+    #   If a block is given, it will be passed the newly created task.
     #
-    # @return [Array] The formatted arguments from a Task object.
+    # @yieldparam [Task] task
+    #   The newly created Task object.
+    #
+    # @return [Array]
+    #   The formatted arguments from a Task object.
     #
     # @example
     #   MyTask.arguments(:verbose => true, :count => 2)
@@ -57,11 +68,24 @@ module RProgram
       self.new(options,&block).arguments
     end
 
+    #
+    # Specifies whether the task will be ran under sudo.
+    #
+    # @return [Boolean]
+    #   Returns +true+ if sudo is enabled, returns +false+ otherwise.
+    #
+    # @since 0.1.8
+    #
+    def sudo?
+      @sudo == true
+    end
+
     #
     # Generates the command-line arguments for all leading non-options.
     #
-    # @return [Array] The command-line arguments generated from all the
-    #                 leading non-options of the task and it's sub-tasks.
+    # @return [Array]
+    #   The command-line arguments generated from all the leading
+    #   non-options of the task and it's sub-tasks.
     #
     def leading_non_options
       args = []
@@ -86,8 +110,9 @@ module RProgram
     #
     # Generates the command-line arguments from all options.
     #
-    # @return [Array] The command-line arguments generated from all the
-    #                 options of the task and it's sub-tasks.
+    # @return [Array]
+    #   The command-line arguments generated from all the options of the
+    #   task and it's sub-tasks.
     #
     def options
       args = []
@@ -109,8 +134,9 @@ module RProgram
     #
     # Generates the command-line arguments from all tailing non-options.
     #
-    # @return [Array] The command-line arguments generated from all the
-    #                 tailing non-options of the task and it's sub-tasks.
+    # @return [Array]
+    #   The command-line arguments generated from all the tailing
+    #   non-options of the task and it's sub-tasks.
     #
     def tailing_non_options
       args = []
@@ -135,9 +161,9 @@ module RProgram
     #
     # Generates the command-line arguments from the task.
     #
-    # @return [Array] The command-line arguments compiled from the
-    #                 leading non-options, options and tailing non-options
-    #                 of the task and it's sub-tasks.
+    # @return [Array]
+    #   The command-line arguments compiled from the leading non-options,
+    #   options and tailing non-options of the task and it's sub-tasks.
     #
     def arguments
       leading_non_options + options + tailing_non_options
@@ -148,8 +174,11 @@ module RProgram
     #
     # Defines a sub-task.
     #
-    # @param [String, Symbol] name The name of the sub-task.
-    # @param [Task] task The task class of the sub-task.
+    # @param [String, Symbol] name
+    #   The name of the sub-task.
+    #
+    # @param [Task] task
+    #   The task class of the sub-task.
     #
     # @example
     #   subtask :extra, ExtraTask
@@ -175,17 +204,20 @@ module RProgram
     #
     # Defines a non-option.
     #
-    # @param [Hash] options Additional options for the non-option.
-    # @option options [Symbol] :name The name of the non-option.
+    # @param [Hash] options
+    #   Additional options for the non-option.
+    #
+    # @option options [Symbol] :name
+    #   The name of the non-option.
+    #
     # @option options [true, false] :leading (true)
-    #                                        Implies the non-option is a
-    #                                        leading non-option.
+    #   Implies the non-option is a leading non-option.
+    #
     # @option options [false, true] :tailing (false)
-    #                                        Implies the non-option is a
-    #                                        tailing non-option.
+    #   Implies the non-option is a tailing non-option.
+    #
     # @option options [false, true] :multiple (false)
-    #                                         Implies the non-option maybe
-    #                                         given an Array of values.
+    #   Implies the non-option maybe given an Array of values.
     #
     # @example
     #   non_option :name => 'input_file', :tailing => true
@@ -214,19 +246,22 @@ module RProgram
     #
     # Defines a long-option.
     #
-    # @param [Hash] options Additional options of the long-option.
-    # @option options [String] :flag The flag to use for the option.
-    # @option options [Symbol] :name The name of the option. Defaults to
-    #                                the flag_namify'ed form of
-    #                                <tt>options[:flag]</tt>, if not given.
+    # @param [Hash] options
+    #   Additional options of the long-option.
+    #
+    # @option options [String] :flag
+    #   The flag to use for the option.
+    #
+    # @option options [Symbol] :name
+    #   The name of the option. Defaults to the flag_namify'ed form of
+    #   <tt>options[:flag]</tt>, if not given.
+    #
     # @option options [true, false] :multiply (false)
-    #                                         Specifies that the option may
-    #                                         appear multiple times in the
-    #                                         arguments.
+    #   Specifies that the option may appear multiple times in the
+    #   arguments.
+    #
     # @option options [true, false] :sub_options (false)
-    #                                            Specifies that the option
-    #                                            contains multiple
-    #                                            sub-options.
+    #   Specifies that the option contains multiple sub-options.
     #
     # @example
     #   long_option :flag => '--output'
@@ -245,17 +280,21 @@ module RProgram
     #
     # Defines a short_option.
     #
-    # @param [Hash] options Additional options for the short-option.
-    # @option options [Symbol, String] :name The name of the short-option.
-    # @option options [String] :flag The flag to use for the short-option.
+    # @param [Hash] options
+    #   Additional options for the short-option.
+    #
+    # @option options [Symbol, String] :name
+    #   The name of the short-option.
+    #
+    # @option options [String] :flag
+    #   The flag to use for the short-option.
+    #
     # @option options [true, false] :multiply (false)
-    #                                         Specifies that the option may
-    #                                         appear multiple times in the
-    #                                         arguments.
+    #   Specifies that the option may appear multiple times in the
+    #   arguments.
+    #
     # @option options [true, false] :sub_options (false)
-    #                                            Specifies that the option
-    #                                            contains multiple
-    #                                            sub-options.
+    #   Specifies that the option contains multiple sub-options.
     #
     # @example
     #   short_option :flag => '-c', :name => :count
@@ -267,17 +306,21 @@ module RProgram
     #
     # Defines an option.
     #
-    # @param [Hash] options Additional options.
-    # @option options [Symbol, String] :name The name of the option.
-    # @option options [String] :flag The flag to use for the option.
+    # @param [Hash] options
+    #   Additional options.
+    #
+    # @option options [Symbol, String] :name
+    #   The name of the option.
+    #
+    # @option options [String] :flag
+    #   The flag to use for the option.
+    #
     # @option options [true, false] :multiple (false)
-    #                                         Specifies that the option may
-    #                                         appear multiple times in the
-    #                                         arguments.
+    #   Specifies that the option may appear multiple times in the
+    #   arguments.
+    #
     # @option options [true, false] :sub_options (false)
-    #                                            Specifies that the option
-    #                                            contains multiple
-    #                                            sub-options.
+    #   Specifies that the option contains multiple sub-options.
     #
     def self.define_option(options,&block)
       method_name = options[:name].to_sym
@@ -306,9 +349,11 @@ module RProgram
     #
     # Converts a long-option flag to a Ruby method name.
     #
-    # @param [String] flag The command-line flag to convert.
+    # @param [String] flag
+    #   The command-line flag to convert.
     #
-    # @return [String] A method-name compatible version of the given flag.
+    # @return [String]
+    #   A method-name compatible version of the given flag.
     # 
     # @example
     #   Task.flag_namify('--output-file')

data/lib/rprogram/version.rb

@@ -1,4 +1,4 @@
 module RProgram
   # Version of RProgram
-  VERSION = '0.1.7'
+  VERSION = '0.1.8'
 end

data/spec/task_spec.rb

@@ -35,6 +35,21 @@ describe Task do
     end
   end
 
+  describe "sudo" do
+    it "should allow passing in the :sudo option" do
+      task = LSTask.new(:sudo => true)
+
+      task.should be_sudo
+    end
+
+    it "should allow enabling sudo after the task has been initialized" do
+      task = LSTask.new
+
+      task.sudo = true
+      task.should be_sudo
+    end
+  end
+
   before(:each) do
     @task = LSTask.new
   end

data/tasks/spec.rb

@@ -0,0 +1,10 @@
+require 'spec/rake/spectask'
+
+desc "Run all specifications"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs += ['lib', 'spec']
+  t.spec_opts = ['--colour', '--format', 'specdoc']
+end
+
+task :test => :spec
+task :default => :spec

data/tasks/yard.rb

@@ -0,0 +1,18 @@
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+unless $LOAD_PATH.include?(lib_dir)
+  $LOAD_PATH.unshift(lib_dir)
+end
+
+require 'rprogram/yard/handlers/ruby'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  t.options = [
+    '--protected',
+    '--files', 'History.txt',
+    '--title', 'RProgram',
+    '--quiet'
+  ]
+end
+
+task :docs => :yard

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rprogram
 version: !ruby/object:Gem::Version 
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors: 
 - Postmodern
@@ -30,28 +30,28 @@ cert_chain:
   pDj+ws7QjtH/Qcrr1l9jfN0ehDs=
   -----END CERTIFICATE-----
 
-date: 2009-09-25 00:00:00 -07:00
+date: 2009-12-24 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: yard
-  type: :runtime
+  name: rspec
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.2.3.5
+        version: 1.2.8
     version: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: yard
   type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.8
+        version: 0.5.2
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
@@ -61,7 +61,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.3
+        version: 2.4.0
     version: 
 description: |-
   RProgram is a library for creating wrappers around command-line programs.
@@ -107,6 +107,8 @@ files:
 - lib/rprogram/yard/handlers/ruby/metaclass_eval_handler.rb
 - lib/rprogram/yard/handlers/ruby/legacy.rb
 - lib/rprogram/yard/handlers/ruby/legacy/metaclass_eval_handler.rb
+- tasks/spec.rb
+- tasks/yard.rb
 - spec/spec_helper.rb
 - spec/classes/named_program.rb
 - spec/classes/aliased_program.rb