rdoc 4.0.1 → 4.1.0.preview.3

data/lib/rdoc/top_level.rb

@@ -30,7 +30,7 @@ class RDoc::TopLevel < RDoc::Context
   attr_accessor :diagram # :nodoc:
 
   ##
-  # The parser that processed this file
+  # The parser class that processed this file
 
   attr_accessor :parser
 
@@ -98,7 +98,7 @@ class RDoc::TopLevel < RDoc::Context
 
   ##
   # Adds class or module +mod+. Used in the building phase
-  # by the ruby parser.
+  # by the Ruby parser.
 
   def add_to_classes_or_modules mod
     @classes_or_modules << mod

data/test/test_rdoc_any_method.rb

@@ -38,10 +38,39 @@ method(a, b) { |c, d| ... }
     assert_equal 'my_c1_m', @c1_m.c_function
   end
 
+  def test_call_seq_equals
+    m = RDoc::AnyMethod.new nil, nil
+
+    m.call_seq = ''
+
+    assert_nil m.call_seq
+
+    m.call_seq = 'foo'
+
+    assert_equal 'foo', m.call_seq
+  end
+
   def test_full_name
     assert_equal 'C1::m', @c1.method_list.first.full_name
   end
 
+  def test_is_alias_for
+    assert_equal @c2_b, @c2_a.is_alias_for
+
+    # set string on instance variable
+    loaded = Marshal.load Marshal.dump @c2_a
+
+    loaded.store = @store
+
+    assert_equal @c2_b, loaded.is_alias_for, 'Marshal.load'
+
+    m1 = RDoc::AnyMethod.new nil, 'm1'
+    m1.store = @store
+    m1.instance_variable_set :@is_alias_for, ['Missing', false, 'method']
+
+    assert_nil m1.is_alias_for, 'missing alias'
+  end
+
   def test_markup_code
     tokens = [
       RDoc::RubyToken::TkCONSTANT. new(0, 0, 0, 'CONSTANT'),
@@ -101,11 +130,14 @@ method(a, b) { |c, d| ... }
   end
 
   def test_marshal_load_aliased_method
-    aliased_method = Marshal.load Marshal.dump(@c2.method_list.last)
+    aliased_method = Marshal.load Marshal.dump(@c2_a)
+
+    aliased_method.store = @store
 
     assert_equal 'C2#a',  aliased_method.full_name
     assert_equal 'C2',    aliased_method.parent_name
     assert_equal '()',    aliased_method.params
+    assert_equal @c2_b,   aliased_method.is_alias_for, 'is_alias_for'
     assert                aliased_method.display?
   end
 
@@ -170,16 +202,87 @@ method(a, b) { |c, d| ... }
     assert_equal nil,            loaded.file
     assert_equal cm,             loaded.parent
     assert_equal section,        loaded.section
+    assert_nil                   loaded.is_alias_for
 
     assert loaded.display?
   end
 
+  def test_marshal_dump_version_2
+    @store.path = Dir.tmpdir
+    top_level = @store.add_file 'file.rb'
+
+    m = RDoc::AnyMethod.new nil, 'method'
+    m.block_params = 'some_block'
+    m.call_seq     = 'call_seq'
+    m.comment      = 'this is a comment'
+    m.params       = 'param'
+    m.record_location top_level
+
+    cm = top_level.add_class RDoc::ClassModule, 'Klass'
+    cm.add_method m
+
+    section = cm.sections.first
+
+    al = RDoc::Alias.new nil, 'method', 'aliased', 'alias comment'
+    al_m = m.add_alias al, cm
+
+    loaded = Marshal.load "\x04\bU:\x14RDoc::AnyMethod[\x14i\bI" +
+                          "\"\vmethod\x06:\x06ETI" +
+                          "\"\x11Klass#method\x06;\x06T0:\vpublic" +
+                          "o:\eRDoc::Markup::Document\b:\v@parts[\x06" +
+                          "o:\x1CRDoc::Markup::Paragraph\x06;\t[\x06I" +
+                          "\"\x16this is a comment\x06;\x06T:\n@file0" +
+                          ":0@omit_headings_from_table_of_contents_below0" +
+                          "I\"\rcall_seq\x06;\x06TI\"\x0Fsome_block\x06" +
+                          ";\x06T[\x06[\aI\"\faliased\x06;\x06To;\b\b;\t" +
+                          "[\x06o;\n\x06;\t[\x06I\"\x12alias comment\x06" +
+                          ";\x06T;\v0;\f0I\"\nparam\x06;\x06TI" +
+                          "\"\ffile.rb\x06;\x06TFI\"\nKlass\x06;\x06T" +
+                          "c\x16RDoc::ClassModule0"
+
+    loaded.store = @store
+
+    comment = doc(para('this is a comment'))
+
+    assert_equal m, loaded
+
+    assert_equal [al_m.name],    loaded.aliases.map { |alas| alas.name }
+    assert_equal 'some_block',   loaded.block_params
+    assert_equal 'call_seq',     loaded.call_seq
+    assert_equal comment,        loaded.comment
+    assert_equal top_level,      loaded.file
+    assert_equal 'Klass#method', loaded.full_name
+    assert_equal 'method',       loaded.name
+    assert_equal 'param',        loaded.params
+    assert_equal nil,            loaded.singleton # defaults to nil
+    assert_equal :public,        loaded.visibility
+    assert_equal cm,             loaded.parent
+    assert_equal section,        loaded.section
+    assert_nil                   loaded.is_alias_for
+  end
+
   def test_name
     m = RDoc::AnyMethod.new nil, nil
 
     assert_nil m.name
   end
 
+  def test_name_call_seq
+    m = RDoc::AnyMethod.new nil, nil
+
+    m.call_seq = "yields(name)\nyields(name, description)"
+
+    assert_equal 'yields', m.name
+  end
+
+  def test_name_call_seq_dot
+    m = RDoc::AnyMethod.new nil, nil
+
+    m.call_seq = "obj.yields(name)\nobj.yields(name, description)"
+
+    assert_equal 'yields', m.name
+  end
+
   def test_param_list_block_params
     m = RDoc::AnyMethod.new nil, 'method'
     m.parent = @c1

data/test/test_rdoc_class_module.rb

@@ -2,13 +2,6 @@ require File.expand_path '../xref_test_case', __FILE__
 
 class TestRDocClassModule < XrefTestCase
 
-  def mu_pp obj
-    s = ''
-    s = PP.pp obj, s
-    s.force_encoding Encoding.default_external if defined? Encoding
-    s.chomp
-  end
-
   def test_add_comment
     tl1 = @store.add_file 'one.rb'
     tl2 = @store.add_file 'two.rb'
@@ -108,23 +101,23 @@ class TestRDocClassModule < XrefTestCase
   def test_documented_eh
     cm = RDoc::ClassModule.new 'C'
 
-    refute cm.documented?
+    refute cm.documented?, 'no comments, no markers'
 
-    cm.add_comment 'hi', @top_level
+    cm.add_comment '', @top_level
 
-    assert cm.documented?
+    refute cm.documented?, 'empty comment'
 
-    cm.comment.replace ''
+    cm.add_comment 'hi', @top_level
 
-    assert cm.documented?
+    assert cm.documented?, 'commented'
 
     cm.comment_location.clear
 
-    refute cm.documented?
+    refute cm.documented?, 'no comment'
 
     cm.document_self = nil # notify :nodoc:
 
-    assert cm.documented?
+    assert cm.documented?, ':nodoc:'
   end
 
   def test_each_ancestor
@@ -289,6 +282,7 @@ class TestRDocClassModule < XrefTestCase
     assert_empty loaded.extends
     assert_empty loaded.method_list
   end
+
   def test_marshal_load_version_0
     tl = @store.add_file 'file.rb'
     ns = tl.add_module RDoc::NormalModule, 'Namespace'
@@ -1454,7 +1448,7 @@ class TestRDocClassModule < XrefTestCase
 
     @c1.update_extends
 
-    assert_equal [a, c], @c1.extends
+    assert_equal [a, b, c], @c1.extends
   end
 
   def test_update_extends_trim

data/test/test_rdoc_code_object.rb

@@ -100,24 +100,56 @@ class TestRDocCodeObject < XrefTestCase
     refute @co.display?
   end
 
+  def test_display_eh_suppress
+    assert @co.display?
+
+    @co.suppress
+
+    refute @co.display?
+
+    @co.comment = comment('hi')
+
+    refute @co.display?
+
+    @co.done_documenting = false
+
+    assert @co.display?
+
+    @co.ignore
+    @co.done_documenting = false
+
+    refute @co.display?
+  end
+
   def test_document_children_equals
     @co.document_children = false
+
     refute @co.document_children
 
-    # TODO this is not true anymore:
-    # test all the nodoc stuff etc...
-    #@c2.document_children = false
-    #assert_empty @c2.classes
+    @store.rdoc.options.visibility = :nodoc
+
+    @co.store = @store
+
+    assert @co.document_children
+
+    @co.document_children = false
+
+    assert @co.document_children
   end
 
   def test_document_self_equals
     @co.document_self = false
     refute @co.document_self
 
-    # TODO this is not true anymore:
-    # test all the nodoc stuff etc...
-    #@c1.document_self = false
-    #assert_empty @c1.method_list
+    @store.rdoc.options.visibility = :nodoc
+
+    @co.store = @store
+
+    assert @co.document_self
+
+    @co.document_self = false
+
+    assert @co.document_self
   end
 
   def test_documented_eh
@@ -159,6 +191,18 @@ class TestRDocCodeObject < XrefTestCase
     @co.done_documenting = false
     assert @co.document_self
     assert @co.document_children
+
+    @co.done_documenting = true
+
+    @store.rdoc.options.visibility = :nodoc
+
+    @co.store = @store
+
+    refute @co.done_documenting
+
+    @co.done_documenting = true
+
+    refute @co.done_documenting
   end
 
   def test_each_parent
@@ -195,6 +239,18 @@ class TestRDocCodeObject < XrefTestCase
     refute @co.document_self
     refute @co.document_children
     assert @co.ignored?
+
+    @store.rdoc.options.visibility = :nodoc
+
+    @co.store = @store
+
+    assert @co.document_self
+    assert @co.document_children
+    refute @co.ignored?
+
+    @co.ignore
+
+    refute @co.ignored?
   end
 
   def test_ignore_eh
@@ -271,6 +327,13 @@ class TestRDocCodeObject < XrefTestCase
     refute @co.ignored?
   end
 
+  def test_record_location_suppressed
+    @co.suppress
+    @co.record_location @xref_data
+
+    refute @co.suppressed?
+  end
+
   def test_section
     parent = RDoc::Context.new
     section = parent.sections.first
@@ -311,6 +374,30 @@ class TestRDocCodeObject < XrefTestCase
     refute @co.ignored?
   end
 
+  def test_start_doc_suppressed
+    @co.suppress
+
+    @co.start_doc
+
+    assert @co.document_self
+    assert @co.document_children
+    refute @co.suppressed?
+  end
+
+  def test_store_equals
+    @co.document_self = false
+
+    @co.store = @store
+
+    refute @co.document_self
+
+    @store.rdoc.options.visibility = :nodoc
+
+    @co.store = @store
+
+    assert @co.document_self
+  end
+
   def test_stop_doc
     @co.document_self = true
     @co.document_children = true
@@ -319,6 +406,44 @@ class TestRDocCodeObject < XrefTestCase
 
     refute @co.document_self
     refute @co.document_children
+
+    @store.rdoc.options.visibility = :nodoc
+
+    @co.store = @store
+
+    assert @co.document_self
+    assert @co.document_children
+
+    @co.stop_doc
+
+    assert @co.document_self
+    assert @co.document_children
+  end
+
+  def test_suppress
+    @co.suppress
+
+    refute @co.document_self
+    refute @co.document_children
+    assert @co.suppressed?
+
+    @store.rdoc.options.visibility = :nodoc
+
+    @co.store = @store
+
+    refute @co.suppressed?
+
+    @co.suppress
+
+    refute @co.suppressed?
+  end
+
+  def test_suppress_eh
+    refute @co.suppressed?
+
+    @co.suppress
+
+    assert @co.suppressed?
   end
 
 end

data/test/test_rdoc_context.rb

@@ -41,6 +41,14 @@ class TestRDocContext < XrefTestCase
     assert_equal [as], @context.unmatched_alias_lists['#old_name']
   end
 
+  def test_add
+    @context.add RDoc::Extend,  'Ext', 'comment'
+    @context.add RDoc::Include, 'Incl', 'comment'
+
+    refute_empty @context.extends
+    refute_empty @context.includes
+  end
+
   def test_add_alias_method_attr
     top_level = @store.add_file 'file.rb'
 
@@ -691,6 +699,15 @@ class TestRDocContext < XrefTestCase
     assert_equal [@apub, @aprot, @apriv], @vis.attributes
   end
 
+  def test_remove_invisible_nodoc
+    util_visibilities
+
+    @vis.remove_invisible :nodoc
+
+    assert_equal [@pub, @prot, @priv], @vis.method_list
+    assert_equal [@apub, @aprot, @apriv], @vis.attributes
+  end
+
   def test_remove_invisible_protected
     util_visibilities
 

data/test/test_rdoc_context_section.rb

@@ -13,13 +13,6 @@ class TestRDocContextSection < RDoc::TestCase
     @s = @S.new @klass, 'section', comment('# comment', @top_level)
   end
 
-  def mu_pp obj
-    s = ''
-    s = PP.pp obj, s
-    s.force_encoding Encoding.default_external if defined? Encoding
-    s.chomp
-  end
-
   def test_add_comment
     file1 = @store.add_file 'file1.rb'