Added --markup command line option to set default format.

Fixed parsing of ClassModule comment_location

RDoc::RDoc.current is set for the entire run.

Author: drbrain

History.txt

@@ -12,6 +12,8 @@
     * TomDoc 1.0.0-pre
     * RD format
 
+    The default format can be set via the <tt>--markup</tt> option.
+
     The format of documentation in a particular file can be specified by the
     +:markup:+ directive.  If the :markup: directive is in the first comment
     it is used as the default for the entire file.  For other comments it
@@ -43,6 +45,7 @@
   * Added RDoc::Comment which encapsulates comment-handling functionality.
   * Added RDoc::Markup::PreProcess::post_process to allow arbitrary comment
     munging.
+  * RDoc::RDoc::current is set for the entire RDoc run.
 
 * Bug fixes
   * Markup defined by RDoc::Markup#add_special inside a <tt><tt></tt> is no

lib/rdoc/class_module.rb

@@ -451,7 +451,7 @@ def parse comment_location
 
       RDoc::Markup::Document.new(*docs)
     when RDoc::Comment then
-      doc = super comment_location.text
+      doc = super comment_location.text, comment_location.format
       doc.file = comment_location.location.absolute_name
       doc
     when RDoc::Markup::Document then

lib/rdoc/generator/markup.rb

@@ -159,6 +159,17 @@ def markup_code
 
 end
 
+class RDoc::ClassModule
+
+  ##
+  # Handy wrapper for marking up this class or module's comment
+
+  def description
+    markup @comment_location
+  end
+
+end
+
 class RDoc::Context::Section
 
   include RDoc::Generator::Markup

lib/rdoc/options.rb

@@ -96,6 +96,12 @@ class RDoc::Options
 
   attr_accessor :main_page
 
+  ##
+  # The default markup format.  The default is 'rdoc'.  'tomdoc' and 'rd' are
+  # also built-in.
+
+  attr_accessor :markup
+
   ##
   # If true, only report on undocumented files
 
@@ -180,6 +186,7 @@ def initialize # :nodoc:
     @hyperlink_all = false
     @line_numbers = false
     @main_page = nil
+    @markup = 'rdoc'
     @coverage_report = false
     @op_dir = nil
     @pipe = false
@@ -448,6 +455,17 @@ def parse(argv)
         @visibility = value
       end
 
+      opt.separator nil
+
+      markup_formats = RDoc::Text::MARKUP_FORMAT.keys.sort
+
+      opt.on("--markup=MARKUP", markup_formats,
+             "The markup format for the named files.",
+             "The default is rdoc.  Valid values are:",
+             markup_formats.join(', ')) do |value|
+        @markup = value
+      end
+
       opt.separator nil
       opt.separator "Common generator options:"
       opt.separator nil

lib/rdoc/parser/ruby.rb

@@ -164,7 +164,7 @@ def initialize(top_level, file_name, content, options, stats)
     @scanner = RDoc::RubyLex.new content, @options
     @scanner.exception_on_syntax_error = false
     @prev_seek = nil
-    @markup = 'rdoc'
+    @markup = @options.markup
 
     @encoding = nil
     @encoding = @options.encoding if Object.const_defined? :Encoding

lib/rdoc/rdoc.rb

@@ -85,7 +85,7 @@ def self.current
   ##
   # Sets the active RDoc::RDoc instance
 
-  def self.current=(rdoc)
+  def self.current= rdoc
     @current = rdoc
   end
 
@@ -95,6 +95,7 @@ def self.current=(rdoc)
   def self.reset
     RDoc::TopLevel.reset
     RDoc::Parser::C.reset
+    RDoc::RDoc.current = nil
   end
 
   ##
@@ -398,6 +399,7 @@ def remove_unparseable files
 
   def document options
     RDoc::RDoc.reset
+    RDoc::RDoc.current = self
 
     if RDoc::Options === options then
       @options = options
@@ -457,18 +459,12 @@ def document options
 
   def generate file_info
     Dir.chdir @options.op_dir do
-      begin
-        self.class.current = self
-
-        unless @options.quiet then
-          $stderr.puts "\nGenerating #{@generator.class.name.sub(/^.*::/, '')} format into #{Dir.pwd}..."
-        end
-
-        @generator.generate file_info
-        update_output_dir '.', @start_time, @last_modified
-      ensure
-        self.class.current = nil
+      unless @options.quiet then
+        $stderr.puts "\nGenerating #{@generator.class.name.sub(/^.*::/, '')} format into #{Dir.pwd}..."
       end
+
+      @generator.generate file_info
+      update_output_dir '.', @start_time, @last_modified
     end
   end
 

test/test_rdoc_class_module.rb

@@ -580,6 +580,19 @@ def test_parse_comment
     assert_equal doc, cm.parse(cm.comment)
   end
 
+  def test_parse_comment_format
+    tl1 = RDoc::TopLevel.new 'one.rb'
+
+    cm = RDoc::ClassModule.new 'Klass'
+    cm.comment = comment 'comment ((*1*))', tl1
+    cm.comment.format = 'rd'
+
+    doc = @RM::Document.new @RM::Paragraph.new 'comment <em>1</em>'
+    doc.file = tl1.absolute_name
+
+    assert_equal doc, cm.parse(cm.comment)
+  end
+
   def test_parse_comment_location
     tl1 = RDoc::TopLevel.new 'one.rb'
     tl2 = RDoc::TopLevel.new 'two.rb'

test/test_rdoc_options.rb

@@ -285,6 +285,17 @@ def test_parse_main
     assert_equal 'MAIN', @options.main_page
   end
 
+  def test_parse_markup
+    out, err = capture_io do
+      @options.parse %w[--markup tomdoc]
+    end
+
+    assert_empty out
+    assert_empty err
+
+    assert_equal 'tomdoc', @options.markup
+  end
+
   def test_parse_template
     out, err = capture_io do
       @options.parse %w[--template darkfish]

test/test_rdoc_rdoc.rb

@@ -13,6 +13,8 @@ def setup
   end
 
   def test_class_reset
+    RDoc::RDoc.current = :junk
+
     tl = RDoc::TopLevel.new 'file.rb'
     tl.add_class RDoc::NormalClass, 'C'
     tl.add_class RDoc::NormalModule, 'M'
@@ -25,6 +27,8 @@ def test_class_reset
 
     RDoc::RDoc.reset
 
+    assert_nil RDoc::RDoc.current
+
     assert_empty RDoc::TopLevel.all_classes_hash
     assert_empty RDoc::TopLevel.all_files_hash
     assert_empty RDoc::TopLevel.all_modules_hash

test/test_rdoc_tom_doc.rb

@@ -92,6 +92,32 @@ def test_parse_arguments_multiline
     assert_equal expected, @TD.parse(text)
   end
 
+  def test_parse_arguments_nested
+    text = <<-TEXT
+Do some stuff
+
+foo - A comment goes here
+      :bar - bar documentation
+    TEXT
+
+    expected =
+      @RM::Document.new(
+        @RM::Paragraph.new('Do some stuff'),
+        @RM::BlankLine.new,
+        @RM::List.new(
+          :LABEL,
+          @RM::ListItem.new(
+            'foo',
+            @RM::Paragraph.new('A comment goes here'),
+            @RM::List.new(
+              :LABEL,
+              @RM::ListItem.new(
+                ':bar',
+                @RM::Paragraph.new('bar documentation'))))))
+
+    assert_equal expected, @TD.parse(text)
+  end
+
   def test_parse_examples
     text = <<-TEXT
 Do some stuff
@@ -201,6 +227,29 @@ def test_tokenize_arguments_multiline
     assert_equal expected, @td.tokens
   end
 
+  def test_tokenize_arguments_nested
+    @td.tokenize <<-TEXT
+Do some stuff
+
+foo - A comment goes here
+      :bar - bar documentation
+    TEXT
+
+    expected = [
+      [:TEXT,    "Do some stuff",              0, 0],
+      [:NEWLINE, "\n",                        13, 0],
+      [:NEWLINE, "\n",                         0, 1],
+      [:LABEL,   "foo",                        0, 2],
+      [:TEXT,    "A comment goes here",        6, 2],
+      [:NEWLINE, "\n",                        25, 2],
+      [:LABEL,   ":bar",                       6, 3],
+      [:TEXT,    "bar documentation",         13, 3],
+      [:NEWLINE, "\n",                        30, 3],
+    ]
+
+    assert_equal expected, @td.tokens
+  end
+
   def test_tokenize_examples
     @td.tokenize <<-TEXT
 Do some stuff