rdoc 3.12.2 → 4.0.0.preview2

data/test/test_rdoc_markup_to_table_of_contents.rb

@@ -46,45 +46,50 @@ class TestRDocMarkupToTableOfContents < RDoc::Markup::FormatterTestCase
     assert_equal [@RM::Heading.new(1, '\\Hello')], @to.res
   end
 
-  alias accept_blank_line             empty
-  alias accept_document               empty
-  alias accept_list_end_bullet        empty
-  alias accept_list_end_label         empty
-  alias accept_list_end_lalpha        empty
-  alias accept_list_end_note          empty
-  alias accept_list_end_number        empty
-  alias accept_list_end_ualpha        empty
-  alias accept_list_item_end_bullet   empty
-  alias accept_list_item_end_label    empty
-  alias accept_list_item_end_lalpha   empty
-  alias accept_list_item_end_note     empty
-  alias accept_list_item_end_number   empty
-  alias accept_list_item_end_ualpha   empty
-  alias accept_list_item_start_bullet empty
-  alias accept_list_item_start_label  empty
-  alias accept_list_item_start_lalpha empty
-  alias accept_list_item_start_note   empty
-  alias accept_list_item_start_note_2 empty
-  alias accept_list_item_start_number empty
-  alias accept_list_item_start_ualpha empty
-  alias accept_list_start_bullet      empty
-  alias accept_list_start_label       empty
-  alias accept_list_start_lalpha      empty
-  alias accept_list_start_note        empty
-  alias accept_list_start_number      empty
-  alias accept_list_start_ualpha      empty
-  alias accept_paragraph              empty
-  alias accept_paragraph_b            empty
-  alias accept_paragraph_i            empty
-  alias accept_paragraph_plus         empty
-  alias accept_paragraph_star         empty
-  alias accept_paragraph_underscore   empty
-  alias accept_raw                    empty
-  alias accept_rule                   empty
-  alias accept_verbatim               empty
-  alias list_nested                   empty
-  alias list_verbatim                 empty
-  alias start_accepting               empty
+  alias accept_blank_line                             empty
+  alias accept_block_quote                            empty
+  alias accept_document                               empty
+  alias accept_list_end_bullet                        empty
+  alias accept_list_end_label                         empty
+  alias accept_list_end_lalpha                        empty
+  alias accept_list_end_note                          empty
+  alias accept_list_end_number                        empty
+  alias accept_list_end_ualpha                        empty
+  alias accept_list_item_end_bullet                   empty
+  alias accept_list_item_end_label                    empty
+  alias accept_list_item_end_lalpha                   empty
+  alias accept_list_item_end_note                     empty
+  alias accept_list_item_end_number                   empty
+  alias accept_list_item_end_ualpha                   empty
+  alias accept_list_item_start_bullet                 empty
+  alias accept_list_item_start_label                  empty
+  alias accept_list_item_start_lalpha                 empty
+  alias accept_list_item_start_note                   empty
+  alias accept_list_item_start_note_2                 empty
+  alias accept_list_item_start_note_multi_description empty
+  alias accept_list_item_start_note_multi_label       empty
+  alias accept_list_item_start_number                 empty
+  alias accept_list_item_start_ualpha                 empty
+  alias accept_list_start_bullet                      empty
+  alias accept_list_start_label                       empty
+  alias accept_list_start_lalpha                      empty
+  alias accept_list_start_note                        empty
+  alias accept_list_start_number                      empty
+  alias accept_list_start_ualpha                      empty
+  alias accept_paragraph                              empty
+  alias accept_paragraph_b                            empty
+  alias accept_paragraph_br                           empty
+  alias accept_paragraph_break                        empty
+  alias accept_paragraph_i                            empty
+  alias accept_paragraph_plus                         empty
+  alias accept_paragraph_star                         empty
+  alias accept_paragraph_underscore                   empty
+  alias accept_raw                                    empty
+  alias accept_rule                                   empty
+  alias accept_verbatim                               empty
+  alias list_nested                                   empty
+  alias list_verbatim                                 empty
+  alias start_accepting                               empty
 
 end
 

data/test/test_rdoc_markup_to_tt_only.rb

@@ -14,6 +14,10 @@ class TestRDocMarkupToTtOnly < RDoc::Markup::FormatterTestCase
     assert_empty @to.end_accepting
   end
 
+  def accept_block_quote
+    assert_empty @to.end_accepting
+  end
+
   def accept_document
     assert_equal [], @to.res
   end
@@ -122,6 +126,10 @@ class TestRDocMarkupToTtOnly < RDoc::Markup::FormatterTestCase
     assert_empty @to.end_accepting
   end
 
+  def accept_paragraph_break
+    assert_empty @to.end_accepting
+  end
+
   def accept_raw
     assert_empty @to.end_accepting
   end
@@ -174,10 +182,22 @@ class TestRDocMarkupToTtOnly < RDoc::Markup::FormatterTestCase
     assert_equal [nil, 'teletype', nil], @to.res
   end
 
+  def accept_list_item_start_note_multi_description
+    assert_empty @to.res
+  end
+
+  def accept_list_item_start_note_multi_label
+    assert_empty @to.res
+  end
+
   def accept_paragraph_b
     assert_empty @to.end_accepting
   end
 
+  def accept_paragraph_br
+    assert_empty @to.end_accepting
+  end
+
   def accept_paragraph_i
     assert_empty @to.end_accepting
   end

data/test/test_rdoc_markup_verbatim.rb

@@ -2,6 +2,19 @@ require 'rdoc/test_case'
 
 class TestRDocMarkupVerbatim < RDoc::TestCase
 
+  def test_equals2
+    v1 = verb('1 + 1')
+    v2 = verb('1 + 1')
+    v3 = verb('1 + 2')
+    v4 = verb('1 + 1')
+    v4.format = :ruby
+
+    assert_equal v1, v2
+
+    refute_equal v1, v3
+    refute_equal v1, v4
+  end
+
   def test_ruby_eh
     verbatim = RDoc::Markup::Verbatim.new
 

data/test/test_rdoc_method_attr.rb

@@ -140,6 +140,11 @@ class TestRDocMethodAttr < XrefTestCase
     assert_equal expected, @c1_m.search_record
   end
 
+  def test_equals2
+    assert_equal @c1_m, @c1_m
+    refute_equal @c1_m, @parent_m
+  end
+
   def test_to_s
     assert_equal 'RDoc::AnyMethod: C1#m',  @c1_m.to_s
     assert_equal 'RDoc::AnyMethod: C2#b',  @c2_b.to_s

data/test/test_rdoc_normal_class.rb

@@ -2,15 +2,34 @@ require File.expand_path '../xref_test_case', __FILE__
 
 class TestRDocNormalClass < XrefTestCase
 
-  def test_ancestors_class
-    top_level = RDoc::TopLevel.new 'file.rb'
-    klass = top_level.add_class RDoc::NormalClass, 'Klass'
+  def test_ancestors
+    klass = @top_level.add_class RDoc::NormalClass, 'Klass'
     incl = RDoc::Include.new 'Incl', ''
 
-    sub_klass = klass.add_class RDoc::NormalClass, 'SubClass', 'Klass'
+    sub_klass = @top_level.add_class RDoc::NormalClass, 'SubClass'
+    sub_klass.superclass = klass
     sub_klass.add_include incl
 
-    assert_equal [incl.name, klass], sub_klass.ancestors
+    assert_equal [incl.name, klass, 'Object'], sub_klass.ancestors
+  end
+
+  def test_ancestors_multilevel
+    c1 = @top_level.add_class RDoc::NormalClass, 'Outer'
+    c2 = @top_level.add_class RDoc::NormalClass, 'Middle', c1
+    c3 = @top_level.add_class RDoc::NormalClass, 'Inner', c2
+
+    assert_equal [c2, c1, 'Object'], c3.ancestors
+  end
+
+  def test_direct_ancestors
+    incl = RDoc::Include.new 'Incl', ''
+
+    c1 = @top_level.add_class RDoc::NormalClass, 'Outer'
+    c2 = @top_level.add_class RDoc::NormalClass, 'Middle', c1
+    c3 = @top_level.add_class RDoc::NormalClass, 'Inner', c2
+    c3.add_include incl
+
+    assert_equal [incl.name, c2], c3.direct_ancestors
   end
 
   def test_definition

data/test/test_rdoc_normal_module.rb

@@ -9,7 +9,7 @@ class TestRDocNormalModule < XrefTestCase
   end
 
   def test_ancestors_module
-    top_level = RDoc::TopLevel.new 'file.rb'
+    top_level = @store.add_file 'file.rb'
     mod = top_level.add_module RDoc::NormalModule, 'Mod'
     incl = RDoc::Include.new 'Incl', ''
 

data/test/test_rdoc_options.rb

@@ -45,7 +45,7 @@ class TestRDocOptions < RDoc::TestCase
   def test_check_files_warn
     @options.verbosity = 2
 
-    out, err = capture_io do
+    out, err = verbose_capture_io do
       @options.files = %w[nonexistent]
 
       @options.check_files
@@ -124,7 +124,7 @@ class TestRDocOptions < RDoc::TestCase
   def test_encoding_default
     skip "Encoding not implemented" unless Object.const_defined? :Encoding
 
-    assert_equal Encoding.default_external, @options.encoding
+    assert_equal Encoding::UTF_8, @options.encoding
   end
 
   def test_generator_descriptions
@@ -195,7 +195,9 @@ rdoc_include:
   def test_parse_copy_files_directory_absolute
     @options.parse %w[--copy-files /]
 
-    assert_equal ['/'], @options.static_path
+    assert_equal 1, @options.static_path.length
+
+    assert_match %r%^([A-Z]:)?/$%i, @options.static_path.first
   end
 
   def test_parse_coverage
@@ -428,6 +430,19 @@ rdoc_include:
     assert_equal 'tomdoc', @options.markup
   end
 
+  def test_parse_root
+    assert_equal Pathname(Dir.pwd), @options.root
+
+    out, err = capture_io do
+      @options.parse %W[--root #{Dir.tmpdir}]
+    end
+
+    assert_empty out
+    assert_empty err
+
+    assert_equal Pathname(Dir.tmpdir), @options.root
+  end
+
   def test_parse_template
     out, err = capture_io do
       @options.parse %w[--template darkfish]
@@ -489,7 +504,7 @@ rdoc_include:
       end
 
       assert_equal 0, e.status
-    
+
       assert File.exist? '.rdoc_options'
     end
   ensure
@@ -557,7 +572,7 @@ rdoc_include:
 
     @options.verbosity = 2
 
-    out, err = capture_io do
+    out, err = verbose_capture_io do
       @options.warn "warnings on"
     end
 
@@ -568,7 +583,7 @@ rdoc_include:
   def test_write_options
     temp_dir do |dir|
       @options.write_options
-    
+
       assert File.exist? '.rdoc_options'
 
       assert_equal @options, YAML.load(File.read('.rdoc_options'))

data/test/test_rdoc_parser.rb

@@ -61,6 +61,20 @@ class TestRDocParser < RDoc::TestCase
     assert_equal @RP::Simple, @RP.can_parse(readme_file_name)
   end
 
+  def test_class_can_parse_forbidden
+    skip 'chmod not supported' if Gem.win_platform?
+
+    Tempfile.open 'forbidden' do |io|
+      begin
+        File.chmod 0000, io.path
+
+        assert_nil @RP.can_parse io.path
+      ensure
+        File.chmod 0400, io.path
+      end
+    end
+  end
+
   ##
   # Selenium hides a .jar file using a .txt extension.
 
@@ -101,6 +115,16 @@ class TestRDocParser < RDoc::TestCase
     assert_equal @RP::RD, parser
   end
 
+  def test_class_use_markup_markdown
+    content = <<-CONTENT
+# coding: utf-8 markup: markdown
+    CONTENT
+
+    parser = @RP.use_markup content
+
+    assert_equal @RP::Ruby, parser
+  end
+
   def test_class_use_markup_modeline
     content = <<-CONTENT
 # -*- coding: utf-8 -*-

data/test/test_rdoc_parser_c.rb

@@ -54,11 +54,11 @@ class TestRDocParserC < RDoc::TestCase
     @tempfile = Tempfile.new self.class.name
     filename = @tempfile.path
 
-    @top_level = RDoc::TopLevel.new filename
+    @top_level = @store.add_file filename
     @fn = filename
     @options = RDoc::Options.new
     @options.verbosity = 2
-    @stats = RDoc::Stats.new 0
+    @stats = RDoc::Stats.new @store, 0
   end
 
   def teardown
@@ -244,11 +244,11 @@ void Init_Blah(void) {
 }
     EOF
 
-    _, err = capture_io do
+    _, err = verbose_capture_io do
       refute util_get_class(content, 'cDate')
     end
 
-    assert_equal "Enclosing class/module \"cDate\" for alias b a not known\n",
+    assert_equal "Enclosing class or module \"cDate\" for alias b a is not known\n",
                  err
   end
 
@@ -388,6 +388,12 @@ void Init_foo(){
     */
    rb_define_const(cFoo, "MULTILINE_NOT_EMPTY", INT2FIX(1));
 
+   /*
+    * Multiline comment goes here because this comment spans multiple lines.
+    * 1: However, the value extraction should only happen for the first line
+    */
+   rb_define_const(cFoo, "MULTILINE_COLON_ON_SECOND_LINE", INT2FIX(1));
+
 }
     EOF
 
@@ -437,6 +443,13 @@ Multiline comment goes here because this comment spans multiple lines.
     assert_equal ['MULTILINE_VALUE',     '1',          comment], constants.shift
     assert_equal ['MULTILINE_NOT_EMPTY', 'INT2FIX(1)', comment], constants.shift
 
+    comment = <<-EOF.chomp
+Multiline comment goes here because this comment spans multiple lines.
+1: However, the value extraction should only happen for the first line
+    EOF
+    assert_equal ['MULTILINE_COLON_ON_SECOND_LINE', 'INT2FIX(1)', comment],
+                 constants.shift
+
     assert constants.empty?, constants.inspect
   end
 
@@ -456,6 +469,7 @@ void Init_curses(){
 
     @parser = util_parser content
 
+    @parser.do_modules
     @parser.do_classes
     @parser.do_constants
 
@@ -469,6 +483,39 @@ void Init_curses(){
     assert_equal 'Value of the color black', constants.first.comment.text
   end
 
+  def test_do_constants_file
+    content = <<-EOF
+void Init_File(void) {
+  rb_cFile = rb_define_class("File", rb_cIO);
+  rb_mFConst = rb_define_module_under(rb_cFile, "Constants");
+  rb_include_module(rb_cIO, rb_mFConst);
+
+  /*  Document-const: LOCK_SH
+   *
+   *  Shared lock
+   */
+  rb_file_const("LOCK_SH", INT2FIX(LOCK_SH));
+}
+    EOF
+
+    @parser = util_parser content
+
+    @parser.do_modules
+    @parser.do_classes
+    @parser.do_constants
+
+    klass = @parser.classes['rb_mFConst']
+
+    constants = klass.constants
+    refute_empty klass.constants
+
+    constant = constants.first
+
+    assert_equal 'LOCK_SH',          constant.name
+    assert_equal 'INT2FIX(LOCK_SH)', constant.value
+    assert_equal 'Shared lock',      constant.comment.text
+  end
+
   def test_do_includes
     content = <<-EOF
 Init_foo() {
@@ -502,7 +549,7 @@ void Init_Blah(void) {
 
     klass = nil
 
-    _, err = capture_io do
+    _, err = verbose_capture_io do
       klass = util_get_class content, 'cDate'
     end
 
@@ -524,7 +571,7 @@ void Init_Blah(void) {
 
     klass = nil
 
-    _, err = capture_io do
+    _, err = verbose_capture_io do
       klass = util_get_class content, 'cDate'
     end
 
@@ -546,7 +593,7 @@ void Init_Blah(void) {
 
     klass = nil
 
-    _, err = capture_io do
+    _, err = verbose_capture_io do
       klass = util_get_class content, 'cDate'
     end
 
@@ -574,8 +621,59 @@ void Init_Blah(void) {
     assert               methods.first.singleton
   end
 
+  def test_do_missing
+    parser = util_parser
+
+    klass_a = @top_level.add_class RDoc::ClassModule, 'A'
+    parser.classes['a'] = klass_a
+
+    parser.enclosure_dependencies['c'] << 'b'
+    parser.enclosure_dependencies['b'] << 'a'
+    parser.enclosure_dependencies['d'] << 'a'
+
+    parser.missing_dependencies['d'] = ['d', :class, 'D', 'Object', 'a']
+    parser.missing_dependencies['c'] = ['c', :class, 'C', 'Object', 'b']
+    parser.missing_dependencies['b'] = ['b', :class, 'B', 'Object', 'a']
+
+    parser.do_missing
+
+    assert_equal %w[A A::B A::B::C A::D],
+                 @store.all_classes_and_modules.map { |m| m.full_name }.sort
+  end
+
+  def test_do_missing_cycle
+    parser = util_parser
+
+    klass_a = @top_level.add_class RDoc::ClassModule, 'A'
+    parser.classes['a'] = klass_a
+
+    parser.enclosure_dependencies['c'] << 'b'
+    parser.enclosure_dependencies['b'] << 'a'
+
+    parser.missing_dependencies['c'] = ['c', :class, 'C', 'Object', 'b']
+    parser.missing_dependencies['b'] = ['b', :class, 'B', 'Object', 'a']
+
+    parser.enclosure_dependencies['y'] << 'z'
+    parser.enclosure_dependencies['z'] << 'y'
+
+    parser.missing_dependencies['y'] = ['y', :class, 'Y', 'Object', 'z']
+    parser.missing_dependencies['z'] = ['z', :class, 'Z', 'Object', 'y']
+
+    _, err = verbose_capture_io do
+      parser.do_missing
+    end
+
+    expected = 'Unable to create class Y (y), class Z (z) ' +
+               'due to a cyclic class or module creation'
+
+    assert_equal expected, err.chomp
+
+    assert_equal %w[A A::B A::B::C],
+                 @store.all_classes_and_modules.map { |m| m.full_name }.sort
+  end
+
   def test_find_alias_comment
-    parser = util_parser ''
+    parser = util_parser
 
     comment = parser.find_alias_comment 'C', '[]', 'index'
 
@@ -594,24 +692,25 @@ rb_define_alias(C, "[]", "index");
     assert_equal "/*\n * comment\n */\n\n", comment.text
   end
 
-  def test_find_class_comment_include
+  def test_find_class_comment
     @options.rdoc_include << File.dirname(__FILE__)
 
     content = <<-EOF
 /*
- * a comment for class Foo
- *
- * :include: test.txt
+ * Comment 1
  */
-void
-Init_Foo(void) {
-  VALUE foo = rb_define_class("Foo", rb_cObject);
-}
+foo = rb_define_class("MyClassName1", rb_cObject);
+
+/*
+ * Comment 2
+ */
+bar = rb_define_class("MyClassName2", rb_cObject);
     EOF
 
-    klass = util_get_class content, 'foo'
+    util_get_class content
 
-    assert_equal "a comment for class Foo\n\ntest file\n", klass.comment.text
+    assert_equal "Comment 1", @parser.classes['foo'].comment.text
+    assert_equal "Comment 2", @parser.classes['bar'].comment.text
   end
 
   def test_find_class_comment_init
@@ -1041,7 +1140,7 @@ If no arguments are given:
 
     COMMENT
 
-    parser = util_parser ''
+    parser = util_parser
     method_obj = RDoc::AnyMethod.new nil, 'blah'
 
     parser.find_modifiers comment, method_obj
@@ -1063,7 +1162,7 @@ commercial() -> Date <br />
 
     COMMENT
 
-    parser = util_parser ''
+    parser = util_parser
     method_obj = RDoc::AnyMethod.new nil, 'blah'
 
     parser.find_modifiers comment, method_obj
@@ -1080,7 +1179,7 @@ commercial() -> Date <br />
 
     COMMENT
 
-    parser = util_parser ''
+    parser = util_parser
     method_obj = RDoc::AnyMethod.new nil, 'blah'
 
     parser.find_modifiers comment, method_obj
@@ -1208,7 +1307,7 @@ void Init_Blah(void) {
   end
 
   def test_look_for_directives_in
-    parser = util_parser ''
+    parser = util_parser
 
     comment = RDoc::Comment.new "# :other: not_handled\n"
 
@@ -1366,7 +1465,7 @@ Init_IO(void) {
   end
 
   def test_rb_scan_args
-    parser = util_parser ''
+    parser = util_parser
 
     assert_equal '(p1)',
                  parser.rb_scan_args('rb_scan_args(a, b, "1",)')
@@ -1424,13 +1523,39 @@ Init_IO(void) {
                  parser.rb_scan_args('rb_scan_args(a, b, "*:&",)')
   end
 
-  def util_get_class(content, name)
+  def test_scan_order_dependent
+    parser = util_parser <<-C
+void a(void) {
+    mA = rb_define_module("A");
+}
+
+void b(void) {
+    cB = rb_define_class_under(mA, "B", rb_cObject);
+}
+
+void c(void) {
+    mC = rb_define_module_under(cB, "C");
+}
+
+void d(void) {
+    mD = rb_define_class_under(mC, "D");
+}
+    C
+
+    parser.scan
+
+    assert_equal %w[A A::B A::B::C],
+                 @store.all_classes_and_modules.map { |m| m.full_name }.sort
+  end
+
+  def util_get_class content, name = nil
     @parser = util_parser content
     @parser.scan
-    @parser.classes[name]
+
+    @parser.classes[name] if name
   end
 
-  def util_parser(content)
+  def util_parser content = ''
     RDoc::Parser::C.new @top_level, @fn, content, @options, @stats
   end