rdoc 3.6.1 → 3.7

data/test/test_rdoc_code_object.rb

@@ -30,6 +30,15 @@ class TestRDocCodeObject < XrefTestCase
     assert_equal 'I am a comment', @co.comment
   end
 
+  def test_comment_equals_document
+    doc = RDoc::Markup::Document.new
+    @co.comment = doc
+
+    @co.comment = ''
+
+    assert_equal doc, @co.comment
+  end
+
   def test_comment_equals_encoding
     skip "Encoding not implemented" unless Object.const_defined? :Encoding
 
@@ -129,6 +138,14 @@ class TestRDocCodeObject < XrefTestCase
     assert_equal [@parent, @xref_data], parents
   end
 
+  def test_file_name
+    assert_equal nil, @co.file_name
+
+    @co.record_location RDoc::TopLevel.new 'lib/file.rb'
+
+    assert_equal 'lib/file.rb', @co.file_name
+  end
+
   def test_full_name_equals
     @co.full_name = 'hi'
 

data/test/test_rdoc_context.rb

@@ -17,6 +17,7 @@ class TestRDocContext < XrefTestCase
     assert_equal nil, @context.parent
     assert_equal :public, @context.visibility
     assert_equal 1, @context.sections.length
+    assert_equal nil, @context.temporary_section
 
     assert_empty @context.classes_hash
     assert_empty @context.modules_hash
@@ -137,6 +138,13 @@ class TestRDocContext < XrefTestCase
     assert_equal 'Object', object.superclass.full_name
   end
 
+  def test_add_class_singleton
+    @c1.add_class RDoc::NormalClass, 'Klass', 'Object'
+
+    assert_includes @c1.classes.map { |k| k.full_name }, 'C1::Klass'
+    assert_includes RDoc::TopLevel.classes.map { |k| k.full_name }, 'C1::Klass'
+  end
+
   def test_add_class_superclass
     @c1.add_class RDoc::NormalClass, 'Klass', 'Object'
     @c1.add_class RDoc::NormalClass, 'Klass', 'Other'
@@ -244,6 +252,29 @@ class TestRDocContext < XrefTestCase
     assert_includes @c1.top_level.requires, req
   end
 
+  def test_add_section
+    default_section = @context.sections.first
+
+    @context.add_section nil, '# comment'
+
+    assert_equal 1, @context.sections.length
+    assert_equal '# comment', @context.sections.first.comment
+
+    @context.add_section nil, '# new comment'
+
+    assert_equal 1, @context.sections.length
+    assert_equal "# comment\n# ---\n# new comment",
+                 @context.sections.first.comment
+
+    @context.add_section 'other', ''
+
+    assert_equal 2, @context.sections.length
+
+    new_section = @context.sections.find { |section| section.title == 'other' }
+    assert new_section
+    assert_equal default_section, @context.current_section
+  end
+
   def test_add_to
     incl = RDoc::Include.new 'Name', 'comment'
     arr = []
@@ -254,6 +285,19 @@ class TestRDocContext < XrefTestCase
     assert_equal @context.current_section, incl.section
   end
 
+  def test_add_to_temporary_section
+    incl = RDoc::Include.new 'Name', 'comment'
+    arr = []
+    section = @context.add_section 'temporary', ''
+    @context.temporary_section = section
+
+    @context.add_to arr, incl
+
+    assert_includes arr, incl
+    assert_equal @context, incl.parent
+    assert_equal section, incl.section
+  end
+
   def test_add_to_no_document_self
     incl = RDoc::Include.new 'Name', 'comment'
     arr = []
@@ -281,6 +325,16 @@ class TestRDocContext < XrefTestCase
     assert_equal %w[C3::H1 C3::H2], @c3.classes.map { |k| k.full_name }
   end
 
+  def test_current_section
+    default_section = @context.current_section
+
+    new_section = @context.add_section 'other', ''
+    @context.temporary_section = new_section
+
+    assert_equal new_section, @context.current_section
+    assert_equal default_section, @context.current_section
+  end
+
   def test_defined_in_eh
     assert @c1.defined_in?(@c1.top_level)
 
@@ -596,6 +650,22 @@ class TestRDocContext < XrefTestCase
     assert_equal [@pub, @prot, @priv], methods
   end
 
+  def test_set_current_section
+    default_section = @context.sections.first
+
+    @context.set_current_section nil, ''
+
+    assert_equal default_section, @context.current_section
+
+    @context.set_current_section 'other', ''
+
+    new_section = @context.sections.find { |section|
+      section != default_section
+    }
+
+    assert_equal new_section, @context.current_section
+  end
+
   def util_visibilities
     @pub  = RDoc::AnyMethod.new nil, 'pub'
     @prot = RDoc::AnyMethod.new nil, 'prot'

data/test/test_rdoc_context_section.rb

@@ -5,7 +5,7 @@ require 'rdoc'
 require 'rdoc/code_objects'
 
 class TestRDocContextSection < MiniTest::Unit::TestCase
-  
+
   def setup
     @S = RDoc::Context::Section
     @s = @S.new nil, 'section', '# comment'

data/test/test_rdoc_generator_ri.rb

@@ -9,6 +9,7 @@ class TestRDocGeneratorRI < MiniTest::Unit::TestCase
 
   def setup
     @options = RDoc::Options.new
+    @options.encoding = Encoding::UTF_8 if Object.const_defined? :Encoding
 
     @pwd = Dir.pwd
     RDoc::TopLevel.reset
@@ -21,9 +22,15 @@ class TestRDocGeneratorRI < MiniTest::Unit::TestCase
 
     @top_level = RDoc::TopLevel.new 'file.rb'
     @klass = @top_level.add_class RDoc::NormalClass, 'Object'
+
     @meth = RDoc::AnyMethod.new nil, 'method'
+    @meth.record_location @top_level
+
     @meth_bang = RDoc::AnyMethod.new nil, 'method!'
+    @meth_bang.record_location @top_level
+
     @attr = RDoc::Attr.new nil, 'attr', 'RW', ''
+    @attr.record_location @top_level
 
     @klass.add_method @meth
     @klass.add_method @meth_bang
@@ -44,9 +51,6 @@ class TestRDocGeneratorRI < MiniTest::Unit::TestCase
   end
 
   def test_generate
-    top_level = RDoc::TopLevel.new 'file.rb'
-    top_level.add_class @klass.class, @klass.name
-
     @g.generate nil
 
     assert_file File.join(@tmpdir, 'cache.ri')
@@ -56,6 +60,13 @@ class TestRDocGeneratorRI < MiniTest::Unit::TestCase
     assert_file File.join(@tmpdir, 'Object', 'attr-i.ri')
     assert_file File.join(@tmpdir, 'Object', 'method-i.ri')
     assert_file File.join(@tmpdir, 'Object', 'method%21-i.ri')
+
+    store = RDoc::RI::Store.new @tmpdir
+    store.load_cache
+
+    encoding = Object.const_defined?(:Encoding) ? Encoding::UTF_8 : nil
+
+    assert_equal encoding, store.encoding
   end
 
   def test_generate_dry_run

data/test/test_rdoc_markup.rb

@@ -18,7 +18,61 @@ the time
     STR
 
     m = RDoc::Markup.new
-    out = m.convert str, RDoc::Markup::ToTest.new
+
+    tt = RDoc::Markup::ToTest.new m
+
+    out = m.convert str, tt
+
+    expected = [
+      "now is the time",
+      "\n",
+      "  hello\n  dave\n",
+      "1: ",
+      "l1",
+      "1: ",
+      "l2",
+    ]
+
+    assert_equal expected, out
+  end
+
+  def test_convert_custom_markup
+    str = <<-STR
+{stricken}
+    STR
+
+    m = RDoc::Markup.new
+    m.add_word_pair '{', '}', :STRIKE
+
+    tt = RDoc::Markup::ToTest.new m
+    tt.add_tag :STRIKE, 'STRIKE ', ' STRIKE'
+
+    out = m.convert str, tt
+
+    expected = [
+      "STRIKE stricken STRIKE",
+    ]
+
+    assert_equal expected, out
+  end
+
+  def test_convert_document
+    doc = RDoc::Markup::Parser.parse <<-STR
+now is
+the time
+
+  hello
+  dave
+
+1. l1
+2. l2
+    STR
+
+    m = RDoc::Markup.new
+
+    tt = RDoc::Markup::ToTest.new m
+
+    out = m.convert doc, tt
 
     expected = [
       "now is the time",

data/test/test_rdoc_markup_document.rb

@@ -47,5 +47,88 @@ class TestRDocMarkupDocument < MiniTest::Unit::TestCase
     end
   end
 
+  def test_empty_eh
+    assert_empty @d
+
+    @d << @RM::BlankLine.new
+
+    refute_empty @d
+  end
+
+  def test_empty_eh_document
+    d = @RM::Document.new @d
+
+    assert_empty d
+  end
+
+  def test_equals2
+    d2 = @RM::Document.new
+
+    assert_equal @d, d2
+
+    d2 << @RM::BlankLine.new
+
+    refute_equal @d, d2
+  end
+
+  def test_equals2_file
+    d2 = @RM::Document.new
+    d2.file = 'file.rb'
+
+    refute_equal @d, d2
+
+    @d.file = 'file.rb'
+
+    assert_equal @d, d2
+  end
+
+  def test_lt2
+    @d << @RM::BlankLine.new
+
+    refute_empty @d
+  end
+
+  def test_merge
+    original = @RM::Document.new @RM::Paragraph.new 'original'
+    original.file = 'file.rb'
+    root = @RM::Document.new original
+
+    replace = @RM::Document.new @RM::Paragraph.new 'replace'
+    replace.file = 'file.rb'
+
+    other = @RM::Document.new replace
+
+    result = root.merge other
+
+    inner = @RM::Document.new @RM::Paragraph.new 'replace'
+    inner.file = 'file.rb'
+    expected = @RM::Document.new inner
+
+    assert_equal expected, result
+  end
+
+  def test_merge_add
+    original = @RM::Document.new @RM::Paragraph.new 'original'
+    original.file = 'file.rb'
+    root = @RM::Document.new original
+
+    addition = @RM::Document.new @RM::Paragraph.new 'addition'
+    addition.file = 'other.rb'
+
+    other = @RM::Document.new addition
+
+    result = root.merge other
+
+    expected = @RM::Document.new original, addition
+
+    assert_equal expected, result
+  end
+
+  def test_push
+    @d.push @RM::BlankLine.new, @RM::BlankLine.new
+
+    refute_empty @d
+  end
+
 end
 

data/test/test_rdoc_markup_indented_paragraph.rb

@@ -0,0 +1,40 @@
+require 'pp'
+require 'rubygems'
+require 'minitest/autorun'
+require 'rdoc/markup'
+
+class TestRDocMarkupIndentedParagraph < MiniTest::Unit::TestCase
+
+  def setup
+    @IP = RDoc::Markup::IndentedParagraph
+  end
+
+  def test_initialize
+    ip = @IP.new 2, 'a', 'b'
+
+    assert_equal 2, ip.indent
+    assert_equal %w[a b], ip.parts
+  end
+
+  def test_accept
+    visitor = Object.new
+    def visitor.accept_indented_paragraph(obj) @obj = obj end
+    def visitor.obj() @obj end
+
+    paragraph = @IP.new 0
+
+    paragraph.accept visitor
+
+    assert_equal paragraph, visitor.obj
+  end
+
+  def test_equals2
+    one = @IP.new 1
+    two = @IP.new 2
+
+    assert_equal one, one
+    refute_equal one, two
+  end
+
+end
+

data/test/test_rdoc_markup_paragraph.rb

@@ -5,5 +5,17 @@ require 'rdoc/markup'
 
 class TestRDocMarkupParagraph < MiniTest::Unit::TestCase
 
+  def test_accept
+    visitor = Object.new
+    def visitor.accept_paragraph(obj) @obj = obj end
+    def visitor.obj() @obj end
+
+    paragraph = RDoc::Markup::Paragraph.new
+
+    paragraph.accept visitor
+
+    assert_equal paragraph, visitor.obj
+  end
+
 end
 

data/test/test_rdoc_markup_pre_process.rb

@@ -43,7 +43,7 @@ contents of a string.
     # FIXME 1.9 fix on windoze
     # preprocessor uses binread, so line endings are \r\n
     expected.gsub!("\n", "\r\n") if
-      RUBY_VERSION =~ /^1.9/ && RUBY_PLATFORM =~ /mswin|mingw/
+      RUBY_VERSION < "1.9.3" && RUBY_PLATFORM =~ /mswin|mingw/
 
     assert_equal expected, content
   end
@@ -67,7 +67,7 @@ contents of a string.
     # FIXME 1.9 fix on windoze
     # preprocessor uses binread, so line endings are \r\n
     expected.gsub!("\n", "\r\n") if
-      RUBY_VERSION =~ /^1.9/ && RUBY_PLATFORM =~ /mswin|mingw/
+      RUBY_VERSION < "1.9.3" && RUBY_PLATFORM =~ /mswin|mingw/
 
     assert_equal expected, content
   end
@@ -96,6 +96,17 @@ contents of a string.
     assert_equal "", text
   end
 
+  def test_handle_category
+    context = RDoc::Context.new
+    original_section = context.current_section
+
+    text = "# :category: other\n"
+
+    @pp.handle text, context
+
+    refute_equal original_section, context.current_section
+  end
+
   def test_handle_code_object
     cd = RDoc::CodeObject.new
     text = "# :x: y\n"

data/test/test_rdoc_markup_to_ansi.rb

@@ -18,6 +18,10 @@ class TestRDocMarkupToAnsi < RDoc::Markup::TextFormatterTestCase
     assert_equal "\e[0m\n", @to.res.join
   end
 
+  def accept_document
+    assert_equal "\e[0mhello\n", @to.res.join
+  end
+
   def accept_heading
     assert_equal "\e[0mHello\n", @to.res.join
   end