RDoc::RDoc#document now takes an RDoc::Options

Author: drbrain

History.txt

@@ -1,5 +1,7 @@
-=== 3.3.1
+=== 3.4
 
+* Minor enhancements
+  * RDoc::RDoc#document may now be called with an RDoc::Options instance.
 * Bug fixes
   * Added skips to Encoding tests running on 1.8.
   * Fixed warnings

lib/rdoc/options.rb

@@ -71,7 +71,7 @@ class RDoc::Options
   attr_accessor :formatter
 
   ##
-  # Description of the output generator (set with the <tt>-fmt</tt> option)
+  # Description of the output generator (set with the <tt>--fmt</tt> option)
 
   attr_accessor :generator
 
@@ -246,6 +246,35 @@ def default_title=(string)
     @title ||= string
   end
 
+  ##
+  # Completes any unfinished option setup business such as filtering for
+  # existent files, creating a regexp for #exclude and setting a default
+  # #template.
+
+  def finish
+    @op_dir ||= 'doc'
+
+    @rdoc_include << "." if @rdoc_include.empty?
+
+    if @exclude.empty? then
+      @exclude = nil
+    else
+      @exclude = Regexp.new(@exclude.join("|"))
+    end
+
+    check_files
+
+    # If no template was specified, use the default template for the output
+    # formatter
+
+    unless @template then
+      @template     = @generator_name
+      @template_dir = template_dir_for @template
+    end
+
+    self
+  end
+
   ##
   # Returns a properly-space list of generators and their descriptions.
 
@@ -273,7 +302,7 @@ def generator_descriptions
   end
 
   ##
-  # Parse command line options.
+  # Parses command line options.
 
   def parse(argv)
     ignore_invalid = true
@@ -677,26 +706,9 @@ def parse(argv)
       end
     end
 
-    @op_dir ||= 'doc'
     @files = argv.dup
 
-    @rdoc_include << "." if @rdoc_include.empty?
-
-    if @exclude.empty? then
-      @exclude = nil
-    else
-      @exclude = Regexp.new(@exclude.join("|"))
-    end
-
-    check_files
-
-    # If no template was specified, use the default template for the output
-    # formatter
-
-    unless @template then
-      @template     = @generator_name
-      @template_dir = template_dir_for @template
-    end
+    finish
   end
 
   ##

lib/rdoc/rdoc.rb

@@ -384,19 +384,27 @@ def remove_unparseable files
   ##
   # Format up one or more files according to the given arguments.
   #
-  # For simplicity, +argv+ is an array of strings, equivalent to the strings
-  # that would be passed on the command line. (This isn't a coincidence, as
-  # we _do_ pass in ARGV when running interactively). For a list of options,
-  # see <tt>rdoc --help</tt>. By default, output will be stored in a directory
-  # called +doc+ below the current directory, so make sure you're somewhere
-  # writable before invoking.
-
-  def document(argv)
+  # +options+ can be either an RDoc::Options instance or an array of strings
+  # equivalent to the strings that would be passed on the command line like
+  # <tt>%w[-q -o doc -t My\ Doc\ Title]</tt>.
+  # #document will automatically call #finish on an RDoc::Options instance.
+  #
+  # For a list of options, see either RDoc::Options or <tt>rdoc --help</tt>.
+  #
+  # By default, output will be stored in a directory called "doc" below the
+  # current directory, so make sure you're somewhere writable before invoking.
+
+  def document options
     RDoc::TopLevel.reset
     RDoc::Parser::C.reset
 
-    @options = RDoc::Options.new
-    @options.parse argv
+    if RDoc::Options === options then
+      @options = options
+      @options.finish
+    else
+      @options = RDoc::Options.new
+      @options.parse options
+    end
 
     if @options.pipe then
       handle_pipe
@@ -478,6 +486,7 @@ def remove_siginfo_handler
         load extension
       rescue => e
         warn "error loading #{extension.inspect}: #{e.message} (#{e.class})"
+        warn "\t#{e.backtrace.join "\n\t"}" if $DEBUG
       end
     end
   end