rdoc 3.9.5 → 3.10.pre.1

data/test/test_rdoc_context.rb

@@ -1,5 +1,3 @@
-require 'rubygems'
-require 'minitest/autorun'
 require File.expand_path '../xref_test_case', __FILE__
 
 class TestRDocContext < XrefTestCase
@@ -255,18 +253,18 @@ class TestRDocContext < XrefTestCase
   def test_add_section
     default_section = @context.sections.first
 
-    @context.add_section nil, '# comment'
+    @context.add_section nil, RDoc::Comment.new('# comment', @top_level)
 
     assert_equal 1, @context.sections.length
-    assert_equal '# comment', @context.sections.first.comment
+    assert_equal '# comment', @context.sections.first.comment.text
 
-    @context.add_section nil, '# new comment'
+    @context.add_section nil, RDoc::Comment.new('# new comment', @top_level)
 
     assert_equal 1, @context.sections.length
     assert_equal "# comment\n# ---\n# new comment",
-                 @context.sections.first.comment
+                 @context.sections.first.comment.text
 
-    @context.add_section 'other', ''
+    @context.add_section 'other', RDoc::Comment.new('', @top_level)
 
     assert_equal 2, @context.sections.length
 
@@ -275,6 +273,23 @@ class TestRDocContext < XrefTestCase
     assert_equal default_section, @context.current_section
   end
 
+  def test_add_section_no_comment
+    default_section = @context.sections.first
+
+    @context.add_section nil
+
+    assert_equal 1, @context.sections.length
+
+    @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 = []
@@ -288,7 +303,8 @@ class TestRDocContext < XrefTestCase
   def test_add_to_temporary_section
     incl = RDoc::Include.new 'Name', 'comment'
     arr = []
-    section = @context.add_section 'temporary', ''
+    section =
+      @context.add_section 'temporary', RDoc::Comment.new('', @top_level)
     @context.temporary_section = section
 
     @context.add_to arr, incl
@@ -328,7 +344,8 @@ class TestRDocContext < XrefTestCase
   def test_current_section
     default_section = @context.current_section
 
-    new_section = @context.add_section 'other', ''
+    new_section =
+      @context.add_section 'other', RDoc::Comment.new('', @top_level)
     @context.temporary_section = new_section
 
     assert_equal new_section, @context.current_section
@@ -653,11 +670,11 @@ class TestRDocContext < XrefTestCase
   def test_set_current_section
     default_section = @context.sections.first
 
-    @context.set_current_section nil, ''
+    @context.set_current_section nil, RDoc::Comment.new('', @top_level)
 
     assert_equal default_section, @context.current_section
 
-    @context.set_current_section 'other', ''
+    @context.set_current_section 'other', RDoc::Comment.new('', @top_level)
 
     new_section = @context.sections.find { |section|
       section != default_section
@@ -666,6 +683,38 @@ class TestRDocContext < XrefTestCase
     assert_equal new_section, @context.current_section
   end
 
+  def test_sort_sections
+    c = RDoc::Context.new
+    c.add_section 'C'
+    c.add_section 'A'
+    c.add_section 'B'
+
+    titles = c.sort_sections.map { |section| section.title }
+
+    assert_equal [nil, 'A', 'B', 'C'], titles
+  end
+
+  def test_sort_sections_tomdoc
+    c = RDoc::Context.new
+    c.add_section 'Public'
+    c.add_section 'Internal'
+    c.add_section 'Deprecated'
+
+    titles = c.sort_sections.map { |section| section.title }
+
+    assert_equal [nil, 'Public', 'Internal', 'Deprecated'], titles
+  end
+
+  def test_sort_sections_tomdoc_missing
+    c = RDoc::Context.new
+    c.add_section 'Internal'
+    c.add_section 'Public'
+
+    titles = c.sort_sections.map { |section| section.title }
+
+    assert_equal [nil, 'Public', 'Internal'], titles
+  end
+
   def util_visibilities
     @pub  = RDoc::AnyMethod.new nil, 'pub'
     @prot = RDoc::AnyMethod.new nil, 'prot'

data/test/test_rdoc_context_section.rb

@@ -1,14 +1,12 @@
-require 'rubygems'
-require 'cgi'
-require 'minitest/autorun'
-require 'rdoc'
-require 'rdoc/code_objects'
+require 'rdoc/test_case'
 
-class TestRDocContextSection < MiniTest::Unit::TestCase
+class TestRDocContextSection < RDoc::TestCase
 
   def setup
+    super
+
     @S = RDoc::Context::Section
-    @s = @S.new nil, 'section', '# comment'
+    @s = @S.new nil, 'section', comment('# comment')
   end
 
   def test_aref
@@ -20,26 +18,27 @@ class TestRDocContextSection < MiniTest::Unit::TestCase
   end
 
   def test_comment_equals
-    @s.comment = "# :section: section\n"
+    @s.comment = RDoc::Comment.new "# :section: section\n"
 
-    assert_equal "# comment", @s.comment
+    assert_equal "# comment", @s.comment.text
 
-    @s.comment = "# :section: section\n# other"
+    @s.comment = RDoc::Comment.new "# :section: section\n# other"
 
-    assert_equal "# comment\n# ---\n# other", @s.comment
+    assert_equal "# comment\n# ---\n# other", @s.comment.text
 
     s = @S.new nil, nil, nil
 
-    s.comment = "# :section:\n# other"
+    s.comment = RDoc::Comment.new "# :section:\n# other"
 
-    assert_equal "# other", s.comment
+    assert_equal "# other", s.comment.text
   end
 
   def test_extract_comment
-    assert_equal '',    @s.extract_comment('')
-    assert_equal '',    @s.extract_comment("# :section: b\n")
-    assert_equal '# c', @s.extract_comment("# :section: b\n# c")
-    assert_equal '# c', @s.extract_comment("# a\n# :section: b\n# c")
+    assert_equal '',    @s.extract_comment(comment('')).text
+    assert_equal '',    @s.extract_comment(comment("# :section: b\n")).text
+    assert_equal '# c', @s.extract_comment(comment("# :section: b\n# c")).text
+    assert_equal '# c',
+                 @s.extract_comment(comment("# a\n# :section: b\n# c")).text
   end
 
   def test_sequence

data/test/test_rdoc_cross_reference.rb

@@ -1,5 +1,3 @@
-require 'rubygems'
-require 'minitest/autorun'
 require File.expand_path '../xref_test_case', __FILE__
 
 class TestRDocCrossReference < XrefTestCase
@@ -131,6 +129,23 @@ class TestRDocCrossReference < XrefTestCase
     assert_ref @c2_c3_m, '::C2::C3#m(*)'
   end
 
+  def test_resolve_percent
+    i_percent = RDoc::AnyMethod.new nil, '%'
+    i_percent.singleton = false
+    @c1.add_method i_percent
+
+    c_percent = RDoc::AnyMethod.new nil, '%'
+    c_percent.singleton = true
+    @c1.add_method c_percent
+
+    assert_ref i_percent, '%'
+    assert_ref i_percent, '#%'
+    assert_ref c_percent, '::%'
+
+    assert_ref i_percent, 'C1#%'
+    assert_ref c_percent, 'C1::%'
+  end
+
   def test_resolve_no_ref
     assert_equal '', @xref.resolve('', '')
 

data/test/test_rdoc_encoding.rb

@@ -1,15 +1,12 @@
 # coding: US-ASCII
 
-require 'rubygems'
-require 'minitest/autorun'
-require 'rdoc'
-require 'rdoc/encoding'
+require 'rdoc/test_case'
 
-require 'tempfile'
-
-class TestRDocEncoding < MiniTest::Unit::TestCase
+class TestRDocEncoding < RDoc::TestCase
 
   def setup
+    super
+
     @tempfile = Tempfile.new 'test_rdoc_encoding'
   end
 

data/test/test_rdoc_generator_darkfish.rb

@@ -1,16 +1,12 @@
-require 'minitest/autorun'
-require 'rdoc/rdoc'
-require 'rdoc/generator/darkfish'
-require 'tmpdir'
-require 'fileutils'
+require 'rdoc/test_case'
 
-class TestRDocGeneratorDarkfish < MiniTest::Unit::TestCase
+class TestRDocGeneratorDarkfish < RDoc::TestCase
 
   def setup
-    @pwd = Dir.pwd
+    super
+
     @lib_dir = "#{@pwd}/lib"
     $LOAD_PATH.unshift @lib_dir # ensure we load from this RDoc
-    RDoc::TopLevel.reset
 
     @options = RDoc::Options.new
     @options.option_parser = OptionParser.new
@@ -22,7 +18,7 @@ class TestRDocGeneratorDarkfish < MiniTest::Unit::TestCase
     @options.generator = RDoc::Generator::Darkfish
 
     $LOAD_PATH.each do |path|
-      darkfish_dir = File.join path, 'rdoc/generator/template/darkfish'
+      darkfish_dir = File.join path, 'rdoc/generator/template/darkfish/'
       next unless File.directory? darkfish_dir
       @options.template_dir = darkfish_dir
       break
@@ -37,6 +33,7 @@ class TestRDocGeneratorDarkfish < MiniTest::Unit::TestCase
     rd.generator = @g
 
     @top_level = RDoc::TopLevel.new 'file.rb'
+    @top_level.parser = RDoc::Parser::Ruby
     @klass = @top_level.add_class RDoc::NormalClass, 'Object'
 
     @meth = RDoc::AnyMethod.new nil, 'method'
@@ -52,6 +49,8 @@ class TestRDocGeneratorDarkfish < MiniTest::Unit::TestCase
   end
 
   def teardown
+    super
+
     $LOAD_PATH.shift
     Dir.chdir @pwd
     FileUtils.rm_rf @tmpdir
@@ -74,6 +73,8 @@ class TestRDocGeneratorDarkfish < MiniTest::Unit::TestCase
     assert_file 'index.html'
     assert_file 'Object.html'
     assert_file 'file_rb.html'
+    assert_file 'table_of_contents.html'
+    assert_file 'js/search_index.js'
 
     encoding = if Object.const_defined? :Encoding then
                  Regexp.escape Encoding.default_external.name
@@ -104,7 +105,7 @@ class TestRDocGeneratorDarkfish < MiniTest::Unit::TestCase
   end
 
   def test_template_for
-    classpage = Pathname.new @options.template_dir + '/classpage.rhtml'
+    classpage = Pathname.new @options.template_dir + 'class.rhtml'
 
     template = @g.send(:template_for, classpage)
     assert_kind_of RDoc::ERBIO, template
@@ -113,7 +114,7 @@ class TestRDocGeneratorDarkfish < MiniTest::Unit::TestCase
   end
 
   def test_template_for_dry_run
-    classpage = Pathname.new @options.template_dir + '/classpage.rhtml'
+    classpage = Pathname.new @options.template_dir + 'class.rhtml'
 
     template = @g.send(:template_for, classpage)
     assert_kind_of ERB, template

data/test/test_rdoc_generator_json_index.rb

@@ -0,0 +1,255 @@
+# coding: US-ASCII
+
+require 'rdoc/test_case'
+
+class TestRDocGeneratorJsonIndex < RDoc::TestCase
+
+  def setup
+    super
+
+    @tmpdir = File.join Dir.tmpdir, "test_rdoc_generator_darkfish_#{$$}"
+    FileUtils.mkdir_p @tmpdir
+
+    @options = RDoc::Options.new
+    @options.files = []
+    # JsonIndex is used in conjunction with another generator
+    @options.setup_generator 'darkfish'
+    @options.template_dir = ''
+    @options.op_dir = @tmpdir
+    @options.option_parser = OptionParser.new
+    @options.finish
+
+    @darkfish = RDoc::Generator::Darkfish.new @options
+    @g = RDoc::Generator::JsonIndex.new @darkfish, @options
+
+    @rdoc = RDoc::RDoc.new
+    @rdoc.options = @options
+    @rdoc.generator = @g
+    RDoc::RDoc.current = @rdoc
+
+    @top_level = RDoc::TopLevel.new 'file.rb'
+    @top_level.parser = RDoc::Parser::Ruby
+
+    @klass = @top_level.add_class RDoc::NormalClass, 'C'
+
+    @meth = @klass.add_method RDoc::AnyMethod.new(nil, 'meth')
+    @meth.record_location @top_level
+
+    @nest_klass = @klass.add_class RDoc::NormalClass, 'D'
+    @nest_klass.record_location @top_level
+
+    @nest_meth = @nest_klass.add_method RDoc::AnyMethod.new(nil, 'meth')
+
+    @ignored = @top_level.add_class RDoc::NormalClass, 'Ignored'
+    @ignored.ignore
+
+    @page = RDoc::TopLevel.new 'page.rdoc'
+    @page.parser = RDoc::Parser::Simple
+
+    @top_levels = [@top_level, @page].sort
+    @klasses    = [@klass, @nest_klass, @ignored]
+
+    Dir.chdir @tmpdir
+  end
+
+  def teardown
+    super
+
+    Dir.chdir @pwd
+    FileUtils.rm_rf @tmpdir
+  end
+
+  def assert_file path
+    assert File.file?(path), "#{path} is not a file"
+  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_dir
+    assert_equal @darkfish.class_dir, @g.class_dir
+  end
+
+  def test_file_dir
+    assert_equal @darkfish.file_dir, @g.file_dir
+  end
+
+  def test_generate
+    @g.generate @top_levels
+
+    assert_file 'js/searcher.js'
+    assert_file 'js/navigation.js'
+    assert_file 'js/search_index.js'
+
+    json = File.read 'js/search_index.js'
+
+    json =~ /\Avar search_data = /
+
+    assignment = $&
+    index = $'
+
+    refute_empty assignment
+
+    index = JSON.parse index
+
+    info = [
+      @klass.search_record[2..-1],
+      @nest_klass.search_record[2..-1],
+      @meth.search_record[2..-1],
+      @nest_meth.search_record[2..-1],
+      @page.search_record[2..-1],
+    ]
+
+    expected = {
+      'index' => {
+        'searchIndex' => [
+          'c',
+          'd',
+          'meth()',
+          'meth()',
+          'page',
+        ],
+        'longSearchIndex' => [
+          'c',
+          'c::d',
+          'c#meth()',
+          'c::d#meth()',
+          '',
+        ],
+        'info' => info,
+      },
+    }
+
+    assert_equal expected, index
+  end
+
+  def test_generate_utf_8
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    text = "5\xB0"
+    text.force_encoding Encoding::ISO_8859_1
+    @klass.add_comment comment(text), @top_level
+
+    @g.generate @top_levels
+
+    json = File.read 'js/search_index.js'
+    json.force_encoding Encoding::UTF_8
+
+    json =~ /\Avar search_data = /
+
+    index = $'
+
+    index = JSON.parse index
+
+    klass_record = @klass.search_record[2..-1]
+    klass_record[-1] = "<p>5\xc2\xb0\n"
+    klass_record.last.force_encoding Encoding::UTF_8
+
+    info = [
+      klass_record,
+      @nest_klass.search_record[2..-1],
+      @meth.search_record[2..-1],
+      @nest_meth.search_record[2..-1],
+      @page.search_record[2..-1],
+    ]
+
+    expected = {
+      'index' => {
+        'searchIndex' => [
+          'c',
+          'd',
+          'meth()',
+          'meth()',
+          'page',
+        ],
+        'longSearchIndex' => [
+          'c',
+          'c::d',
+          'c#meth()',
+          'c::d#meth()',
+          '',
+        ],
+        'info' => info,
+      },
+    }
+
+    assert_equal expected, index
+  end
+
+  def test_index_classes
+    @g.reset @top_levels, @klasses
+
+    @g.index_classes
+
+    expected = {
+      :searchIndex     => %w[c d],
+      :longSearchIndex => %w[c c::d],
+      :info            => [
+        @klass.search_record[2..-1],
+        @nest_klass.search_record[2..-1],
+      ],
+    }
+
+    assert_equal expected, @g.index
+  end
+
+  def test_index_classes_nodoc
+    @klass.document_self      = false
+    @nest_klass.document_self = false
+    @meth.document_self       = false
+    @nest_meth.document_self  = false
+
+    @g.reset @top_levels, @klasses
+
+    @g.index_classes
+
+    expected = {
+      :searchIndex     => [],
+      :longSearchIndex => [],
+      :info            => [],
+    }
+
+    assert_equal expected, @g.index
+  end
+
+  def test_index_methods
+    @g.reset @top_levels, @klasses
+
+    @g.index_methods
+
+    expected = {
+      :searchIndex     => %w[meth() meth()],
+      :longSearchIndex => %w[c#meth() c::d#meth()],
+      :info            => [
+        @meth.search_record[2..-1],
+        @nest_meth.search_record[2..-1],
+      ],
+    }
+
+    assert_equal expected, @g.index
+  end
+
+  def test_index_pages
+    @g.reset @top_levels, @klasses
+
+    @g.index_pages
+
+    expected = {
+      :searchIndex     => %w[page],
+      :longSearchIndex => [''],
+      :info            => [@page.search_record[2..-1]],
+    }
+
+    assert_equal expected, @g.index
+  end
+
+  def test_search_string
+    assert_equal 'cd', @g.search_string('C d')
+  end
+
+end
+