rdoc 4.0.0.preview2 → 4.0.0.preview2.1

data/test/test_rdoc_class_module.rb

@@ -41,6 +41,16 @@ class TestRDocClassModule < XrefTestCase
     assert_equal 'comment', cm.comment.text
   end
 
+  def test_add_comment_duplicate
+    tl1 = @store.add_file 'one.rb'
+
+    cm = RDoc::ClassModule.new 'Klass'
+    cm.add_comment '# comment 1', tl1
+    cm.add_comment '# comment 2', tl1
+
+    assert_equal [['comment 2', tl1]], cm.comment_location
+  end
+
   def test_add_comment_stopdoc
     tl = @store.add_file 'file.rb'
 
@@ -95,6 +105,28 @@ class TestRDocClassModule < XrefTestCase
     refute @c1.document_self_or_methods
   end
 
+  def test_documented_eh
+    cm = RDoc::ClassModule.new 'C'
+
+    refute cm.documented?
+
+    cm.add_comment 'hi', @top_level
+
+    assert cm.documented?
+
+    cm.comment.replace ''
+
+    assert cm.documented?
+
+    cm.comment_location.clear
+
+    refute cm.documented?
+
+    cm.document_self = nil # notify :nodoc:
+
+    assert cm.documented?
+  end
+
   def test_each_ancestor
     assert_equal [@parent], @child.each_ancestor.to_a
   end

data/test/test_rdoc_context.rb

@@ -244,6 +244,31 @@ class TestRDocContext < XrefTestCase
     assert_equal 'first', method.comment.text
   end
 
+  def test_add_method_duplicate_loading
+    @context.store = nil
+
+    meth1 = RDoc::AnyMethod.new nil, 'name'
+    meth1.record_location @store.add_file 'first.rb'
+    meth1.visibility = nil
+    meth1.comment = comment 'first'
+
+    @context.add_method meth1
+
+    meth2 = RDoc::AnyMethod.new nil, 'name'
+    meth2.record_location @store.add_file 'second.rb'
+    meth2.comment = comment 'second'
+
+    _, err = verbose_capture_io do
+      @context.add_method meth2
+    end
+
+    assert_empty err
+
+    method = @context.method_list.first
+
+    assert_equal 'first', method.comment.text
+  end
+
   def test_add_module
     @c1.add_module RDoc::NormalModule, 'Mod'
 

data/test/test_rdoc_markup_document.rb

@@ -191,5 +191,24 @@ class TestRDocMarkupDocument < RDoc::TestCase
     assert_equal expected, doc.table_of_contents
   end
 
+  def test_table_of_contents_omit_headings_below
+    document = doc(
+      head(1, 'A'),
+      para('B'),
+      head(2, 'C'),
+      para('D'),
+      head(1, 'E'),
+      para('F'))
+
+    document.omit_headings_below = 1
+
+    expected = [
+      head(1, 'A'),
+      head(1, 'E'),
+    ]
+
+    assert_equal expected, document.table_of_contents
+  end
+
 end
 

data/test/test_rdoc_markup_to_table_of_contents.rb

@@ -91,5 +91,36 @@ class TestRDocMarkupToTableOfContents < RDoc::Markup::FormatterTestCase
   alias list_verbatim                                 empty
   alias start_accepting                               empty
 
+  def test_accept_document_omit_headings_below
+    document = doc
+    document.omit_headings_below = 2
+
+    @to.accept_document document
+
+    assert_equal 2, @to.omit_headings_below
+  end
+
+  def test_accept_heading_suppressed
+    @to.start_accepting
+    @to.omit_headings_below = 4
+
+    suppressed = head 5, 'Hello'
+
+    @to.accept_heading suppressed
+
+    assert_empty @to.res
+  end
+
+  def test_suppressed_eh
+    @to.omit_headings_below = nil
+
+    refute @to.suppressed? head(1, '')
+
+    @to.omit_headings_below = 1
+
+    refute @to.suppressed? head(1, '')
+    assert @to.suppressed? head(2, '')
+  end
+
 end
 

data/test/test_rdoc_options.rb

@@ -76,6 +76,7 @@ class TestRDocOptions < RDoc::TestCase
       'line_numbers'   => false,
       'main_page'      => nil,
       'markup'         => 'rdoc',
+      'page_dir'       => nil,
       'rdoc_include'   => [],
       'show_hash'      => false,
       'static_path'    => [],
@@ -430,6 +431,43 @@ rdoc_include:
     assert_equal 'tomdoc', @options.markup
   end
 
+  def test_parse_page_dir
+    assert_nil @options.page_dir
+
+    out, err = capture_io do
+      @options.parse %W[--page-dir #{Dir.tmpdir}]
+    end
+
+    assert_empty out
+    assert_empty err
+
+    expected =
+      Pathname(Dir.tmpdir).expand_path.relative_path_from @options.root
+
+    assert_equal expected,     @options.page_dir
+    assert_equal [Dir.tmpdir], @options.files
+  end
+
+  def test_parse_page_dir_root
+    assert_nil @options.page_dir
+
+    Dir.mktmpdir do |dir|
+      abs_root     = dir
+      abs_page_dir = File.join dir, 'pages'
+      FileUtils.mkdir abs_page_dir
+
+      out, err = capture_io do
+        @options.parse %W[--page-dir #{abs_page_dir} --root #{abs_root}]
+      end
+
+      assert_empty out
+      assert_empty err
+
+      assert_equal Pathname('pages'), @options.page_dir
+      assert_equal [abs_page_dir],    @options.files
+    end
+  end
+
   def test_parse_root
     assert_equal Pathname(Dir.pwd), @options.root
 

data/test/test_rdoc_parser.rb

@@ -1,3 +1,5 @@
+# -*- coding: us-ascii -*-
+
 require 'rdoc/test_case'
 
 class TestRDocParser < RDoc::TestCase
@@ -75,6 +77,20 @@ class TestRDocParser < RDoc::TestCase
     end
   end
 
+  def test_can_parse_modeline
+    readme_ext = File.join Dir.tmpdir, "README.EXT.#{$$}"
+
+    open readme_ext, 'w' do |io|
+      io.puts "# README.EXT -  -*- rdoc -*- created at: Mon Aug 7 16:45:54 JST 1995"
+      io.puts
+      io.puts "This document explains how to make extension libraries for Ruby."
+    end
+
+    assert_equal RDoc::Parser::Simple, @RP.can_parse(readme_ext)
+  ensure
+    File.unlink readme_ext
+  end
+
   ##
   # Selenium hides a .jar file using a .txt extension.
 
@@ -83,6 +99,46 @@ class TestRDocParser < RDoc::TestCase
     assert_nil @RP.can_parse(hidden_zip)
   end
 
+  def test_check_modeline
+    readme_ext = File.join Dir.tmpdir, "README.EXT.#{$$}"
+
+    open readme_ext, 'w' do |io|
+      io.puts "# README.EXT -  -*- RDoc -*- created at: Mon Aug 7 16:45:54 JST 1995"
+      io.puts
+      io.puts "This document explains how to make extension libraries for Ruby."
+    end
+
+    assert_equal 'rdoc', @RP.check_modeline(readme_ext)
+  ensure
+    File.unlink readme_ext
+  end
+
+  def test_check_modeline_with_other
+    readme_ext = File.join Dir.tmpdir, "README.EXT.#{$$}"
+
+    open readme_ext, 'w' do |io|
+      io.puts "# README.EXT -  -*- mode: RDoc; indent-tabs-mode: nil -*-"
+      io.puts
+      io.puts "This document explains how to make extension libraries for Ruby."
+    end
+
+    assert_equal 'rdoc', @RP.check_modeline(readme_ext)
+  ensure
+    File.unlink readme_ext
+  end
+
+  def test_check_modeline_no_modeline
+    readme_ext = File.join Dir.tmpdir, "README.EXT.#{$$}"
+
+    open readme_ext, 'w' do |io|
+      io.puts "This document explains how to make extension libraries for Ruby."
+    end
+
+    assert_nil @RP.check_modeline(readme_ext)
+  ensure
+    File.unlink readme_ext
+  end
+
   def test_class_for_binary
     rp = @RP.dup
 

data/test/test_rdoc_parser_c.rb

@@ -40,12 +40,6 @@ assert call-seq correct
 
 =end
 
-class RDoc::Parser::C
-  attr_accessor :classes
-
-  public :do_classes, :do_constants
-end
-
 class TestRDocParserC < RDoc::TestCase
 
   def setup
@@ -83,6 +77,37 @@ class TestRDocParserC < RDoc::TestCase
     assert_equal c_parser, c_parser.can_parse('file.y')
   end
 
+  def test_initialize
+    some_ext        = @top_level.add_class RDoc::NormalClass, 'SomeExt'
+                      @top_level.add_class RDoc::SingleClass, 'SomeExtSingle'
+
+    @store.cache[:c_class_variables] = {
+      @fn => { 'cSomeExt' => 'SomeExt' }
+    }
+
+    @store.cache[:c_singleton_class_variables] = {
+      @fn => { 'cSomeExtSingle' => 'SomeExtSingle' }
+    }
+
+    parser = RDoc::Parser::C.new @top_level, @fn, '', @options, @stats
+
+    expected = { 'cSomeExt' => some_ext }
+    assert_equal expected, parser.classes
+
+    expected = { 'cSomeExtSingle' => 'SomeExtSingle' }
+    assert_equal expected, parser.singleton_classes
+
+    expected = {
+      'cSomeExt'       => 'SomeExt',
+      'cSomeExtSingle' => 'SomeExtSingle',
+    }
+    known_classes = parser.known_classes.delete_if do |key, _|
+      RDoc::KNOWN_CLASSES.keys.include? key
+    end
+
+    assert_equal expected, known_classes
+  end
+
   def test_do_attr_rb_attr
     content = <<-EOF
 void Init_Blah(void) {
@@ -1317,6 +1342,81 @@ void Init_Blah(void) {
     assert_equal 'not_handled', @top_level.metadata['other']
   end
 
+  def test_load_variable_map
+    some_ext = @top_level.add_class RDoc::NormalClass, 'SomeExt'
+               @top_level.add_class RDoc::NormalClass, 'OtherExt'
+
+    @store.cache[:c_class_variables][@fn]       = { 'cSomeExt'  => 'SomeExt'  }
+    @store.cache[:c_class_variables]['other.c'] = { 'cOtherExt' => 'OtherExt' }
+
+    parser = util_parser
+
+    map = parser.load_variable_map :c_class_variables
+
+    expected = { 'cSomeExt' => some_ext }
+
+    assert_equal expected, map
+
+    assert_equal 'SomeExt', parser.known_classes['cSomeExt']
+    assert_nil              parser.known_classes['cOtherExt']
+  end
+
+  def test_load_variable_map_empty
+    parser = util_parser
+
+    map = parser.load_variable_map :c_class_variables
+
+    assert_empty map
+  end
+
+  def test_load_variable_map_legacy
+    @store.cache[:c_class_variables] = nil
+
+    parser = util_parser
+
+    map = parser.load_variable_map :c_class_variables
+
+    assert_empty map
+  end
+
+  def test_load_variable_map_singleton
+    @top_level.add_class RDoc::NormalClass, 'SomeExt'
+    @top_level.add_class RDoc::NormalClass, 'OtherExt'
+
+    @store.cache[:c_singleton_class_variables][@fn] =
+      { 'cSomeExt'  => 'SomeExt'  }
+    @store.cache[:c_singleton_class_variables]['other.c'] =
+      { 'cOtherExt' => 'OtherExt' }
+
+    parser = util_parser
+
+    map = parser.load_variable_map :c_singleton_class_variables
+
+    expected = { 'cSomeExt' => 'SomeExt' }
+
+    assert_equal expected, map
+
+    assert_equal 'SomeExt', parser.known_classes['cSomeExt']
+    assert_nil              parser.known_classes['cOtherExt']
+  end
+
+  def test_load_variable_map_trim
+    a = @top_level.add_class RDoc::NormalClass, 'A'
+
+    @store.cache[:c_class_variables][@fn] = {
+      'cA'  => 'A',
+      'cB'  => 'B',
+    }
+
+    parser = util_parser
+
+    map = parser.load_variable_map :c_class_variables
+
+    expected = { 'cA' => a }
+
+    assert_equal expected, map
+  end
+
   def test_define_method
     content = <<-EOF
 /*Method Comment! */
@@ -1523,6 +1623,29 @@ Init_IO(void) {
                  parser.rb_scan_args('rb_scan_args(a, b, "*:&",)')
   end
 
+  def test_scan
+    parser = util_parser <<-C
+void Init(void) {
+    mM = rb_define_module("M");
+    cC = rb_define_class("C", rb_cObject);
+    sC = rb_singleton_class(cC);
+}
+    C
+
+    parser.scan
+
+    expected = {
+      @fn => {
+        'mM' => 'M',
+        'cC' => 'C', }}
+    assert_equal expected, @store.c_class_variables
+
+    expected = {
+      @fn => {
+        'sC' => 'C' } }
+    assert_equal expected, @store.c_singleton_class_variables
+  end
+
   def test_scan_order_dependent
     parser = util_parser <<-C
 void a(void) {

data/test/test_rdoc_parser_changelog.rb

@@ -0,0 +1,294 @@
+require 'rdoc/test_case'
+
+class TestRDocParserChangeLog < RDoc::TestCase
+
+  def setup
+    super
+
+    @tempfile  = Tempfile.new 'ChangeLog'
+    @top_level = @store.add_file @tempfile.path
+    @options   = RDoc::Options.new
+    @stats     = RDoc::Stats.new @store, 0
+  end
+
+  def teardown
+    @tempfile.close
+  end
+
+  def mu_pp obj
+    s = ''
+    s = PP.pp obj, s
+    s = s.force_encoding Encoding.default_external if defined? Encoding
+    s.chomp
+  end
+
+  def test_class_can_parse
+    parser = RDoc::Parser::ChangeLog
+
+    assert_equal parser, parser.can_parse('ChangeLog')
+
+    assert_equal parser, parser.can_parse(@tempfile.path)
+
+    assert_equal RDoc::Parser::Ruby, parser.can_parse('ChangeLog.rb')
+  end
+
+  def test_continue_entry_body
+    parser = util_parser
+
+    entry_body = ['a']
+
+    parser.continue_entry_body entry_body, 'b'
+
+    assert_equal ['a b'], entry_body
+  end
+
+  def test_continue_entry_body_empty
+    parser = util_parser
+
+    entry_body = []
+
+    parser.continue_entry_body entry_body, ''
+
+    assert_empty entry_body
+  end
+
+  def test_continue_entry_body_function
+    parser = util_parser
+
+    entry_body = ['file: (func1)']
+
+    parser.continue_entry_body entry_body, '(func2): blah'
+
+    assert_equal ['file: (func1, func2): blah'], entry_body
+  end
+
+  def test_create_document
+    parser = util_parser
+
+    groups = {
+      '2012-12-04' => [
+        ['Tue Dec  4 08:33:46 2012  Eric Hodel  <drbrain@segment7.net>',
+          %w[a:one b:two]],
+        ['Tue Dec  4 08:32:10 2012  Eric Hodel  <drbrain@segment7.net>',
+          %w[c:three d:four]]],
+      '2012-12-03' => [
+        ['Mon Dec  3 20:28:02 2012  Koichi Sasada  <ko1@atdot.net>',
+          %w[e:five f:six]]],
+    }
+
+    expected =
+      doc(
+        head(1, File.basename(@tempfile.path)),
+        blank_line,
+        head(2, '2012-12-04'),
+        blank_line,
+        head(3, 'Tue Dec  4 08:33:46 2012  Eric Hodel  <drbrain@segment7.net>'),
+        blank_line,
+        list(:NOTE, item('a', para('one')), item('b', para('two'))),
+        head(3, 'Tue Dec  4 08:32:10 2012  Eric Hodel  <drbrain@segment7.net>'),
+        blank_line,
+        list(:NOTE, item('c', para('three')), item('d', para('four'))),
+        head(2, '2012-12-03'),
+        blank_line,
+        head(3, 'Mon Dec  3 20:28:02 2012  Koichi Sasada  <ko1@atdot.net>'),
+        blank_line,
+        list(:NOTE, item('e', para('five')), item('f', para('six'))))
+
+    expected.file = @top_level
+
+    document = parser.create_document(groups)
+
+    assert_equal expected, document
+
+    assert_equal 2, document.omit_headings_below
+
+    headings = document.parts.select do |part|
+      RDoc::Markup::Heading === part and part.level == 2
+    end
+
+    refute headings.all? { |heading| heading.text.frozen? }
+  end
+
+  def test_create_entries
+    parser = util_parser
+
+    entries = [
+      ['Tue Dec  1 02:03:04 2012  Eric Hodel  <drbrain@segment7.net>',
+        %w[a:one b:two]],
+      ['Tue Dec  5 06:07:08 2012  Eric Hodel  <drbrain@segment7.net>',
+        %w[c:three d:four]],
+    ]
+
+    expected = [
+      head(3, 'Tue Dec  1 02:03:04 2012  Eric Hodel  <drbrain@segment7.net>'),
+      blank_line,
+      list(:NOTE, item('a', para('one')), item('b', para('two'))),
+      head(3, 'Tue Dec  5 06:07:08 2012  Eric Hodel  <drbrain@segment7.net>'),
+      blank_line,
+      list(:NOTE, item('c', para('three')), item('d', para('four'))),
+    ]
+
+    entries = parser.create_entries(entries)
+    assert_equal expected, entries
+  end
+
+  def test_create_entries_colons
+    parser = util_parser
+
+    entries = [
+      ['Wed Dec  5 12:17:11 2012  Naohisa Goto  <ngotogenome@gmail.com>',
+        ['func.rb (DL::Function#bind): log stuff [ruby-core:50562]']],
+    ]
+
+    expected = [
+      head(3,
+           'Wed Dec  5 12:17:11 2012  Naohisa Goto  <ngotogenome@gmail.com>'),
+      blank_line,
+      list(:NOTE,
+           item('func.rb (DL::Function#bind)',
+                para('log stuff [ruby-core:50562]')))]
+
+    assert_equal expected, parser.create_entries(entries)
+  end
+
+  def test_create_items
+    parser = util_parser
+
+    items = [
+	    'README.EXT:  Converted to RDoc format',
+	    'README.EXT.ja:  ditto',
+    ]
+
+    expected =
+      list(:NOTE,
+        item('README.EXT',
+          para('Converted to RDoc format')),
+        item('README.EXT.ja',
+          para('ditto')))
+
+    assert_equal expected, parser.create_items(items)
+  end
+
+  def test_group_entries
+    parser = util_parser
+
+    entries = [
+      [ 'Tue Dec  4 08:33:46 2012  Eric Hodel  <drbrain@segment7.net>',
+        %w[one two]],
+      [ 'Tue Dec  4 08:32:10 2012  Eric Hodel  <drbrain@segment7.net>',
+        %w[three four]],
+      [ 'Mon Dec  3 20:28:02 2012  Koichi Sasada  <ko1@atdot.net>',
+        %w[five six]]]
+
+    expected = {
+      '2012-12-04' => [
+        ['Tue Dec  4 08:33:46 2012  Eric Hodel  <drbrain@segment7.net>',
+          %w[one two]],
+        ['Tue Dec  4 08:32:10 2012  Eric Hodel  <drbrain@segment7.net>',
+          %w[three four]]],
+      '2012-12-03' => [
+        ['Mon Dec  3 20:28:02 2012  Koichi Sasada  <ko1@atdot.net>',
+          %w[five six]]],
+    }
+
+    assert_equal expected, parser.group_entries(entries)
+  end
+
+  def test_parse_entries
+    parser = util_parser <<-ChangeLog
+Tue Dec  4 08:33:46 2012  Eric Hodel  <drbrain@segment7.net>
+
+	* README.EXT:  Converted to RDoc format
+	* README.EXT.ja:  ditto
+
+Mon Dec  3 20:28:02 2012  Koichi Sasada  <ko1@atdot.net>
+
+	* compile.c (iseq_specialized_instruction):
+	  change condition of using `opt_send_simple'.
+	  More method invocations can be simple.
+
+Other note that will be ignored
+
+    ChangeLog
+
+    expected = [
+      [ 'Tue Dec  4 08:33:46 2012  Eric Hodel  <drbrain@segment7.net>',
+        [ 'README.EXT:  Converted to RDoc format',
+          'README.EXT.ja:  ditto']],
+      [ 'Mon Dec  3 20:28:02 2012  Koichi Sasada  <ko1@atdot.net>',
+        [ 'compile.c (iseq_specialized_instruction): change condition of ' +
+          'using `opt_send_simple\'. More method invocations can be simple.']]]
+
+    assert_equal expected, parser.parse_entries
+  end
+
+  def test_parse_entries_gnu
+    parser = util_parser <<-ChangeLog
+1998-08-17  Richard Stallman  <rms@gnu.org>
+
+* register.el (insert-register): Return nil.
+(jump-to-register): Likewise.
+
+* sort.el (sort-subr): Return nil.
+
+* keyboard.c (menu_bar_items, tool_bar_items)
+(Fexecute_extended_command): Deal with 'keymap' property.
+    ChangeLog
+
+    expected = [
+      [ '1998-08-17  Richard Stallman  <rms@gnu.org>',
+        [ 'register.el (insert-register): Return nil.',
+          '(jump-to-register): Likewise.',
+          'sort.el (sort-subr): Return nil.',
+          'keyboard.c (menu_bar_items, tool_bar_items, ' +
+          'Fexecute_extended_command): Deal with \'keymap\' property.']]]
+
+    assert_equal expected, parser.parse_entries
+  end
+
+  def test_scan
+    parser = util_parser <<-ChangeLog
+Tue Dec  4 08:32:10 2012  Eric Hodel  <drbrain@segment7.net>
+
+	* lib/rdoc/ri/driver.rb:  Fixed ri page display for files with
+	  extensions.
+	* test/rdoc/test_rdoc_ri_driver.rb:  Test for above
+
+Mon Dec  3 20:37:22 2012  Koichi Sasada  <ko1@atdot.net>
+
+	* vm_exec.c: check VM_COLLECT_USAGE_DETAILS.
+
+    ChangeLog
+
+    parser.scan
+
+    expected = doc(
+      head(1, File.basename(@tempfile.path)),
+      blank_line,
+      head(2, '2012-12-04'),
+      blank_line,
+      head(3, 'Tue Dec  4 08:32:10 2012  Eric Hodel  <drbrain@segment7.net>'),
+      blank_line,
+      list(:NOTE,
+        item('lib/rdoc/ri/driver.rb', para('Fixed ri page display for ' +
+                       'files with extensions.')),
+        item('test/rdoc/test_rdoc_ri_driver.rb', para('Test for above'))),
+      head(2, '2012-12-03'),
+      blank_line,
+      head(3, 'Mon Dec  3 20:37:22 2012  Koichi Sasada  <ko1@atdot.net>'),
+      blank_line,
+      list(:NOTE,
+        item('vm_exec.c', para('check VM_COLLECT_USAGE_DETAILS.'))))
+
+    expected.file = @top_level
+
+    assert_equal expected, @top_level.comment
+  end
+
+  def util_parser content = ''
+    RDoc::Parser::ChangeLog.new \
+      @top_level, @tempfile.path, content, @options, @stats
+  end
+
+end
+