rdoc 4.0.1 → 4.1.0.preview.3

data/test/test_rdoc_markup_parser.rb

@@ -12,13 +12,6 @@ class TestRDocMarkupParser < RDoc::TestCase
     @RMP = @RM::Parser
   end
 
-  def mu_pp(obj)
-    s = ''
-    s = PP.pp obj, s
-    s = s.force_encoding(Encoding.default_external) if @have_encoding
-    s.chomp
-  end
-
   def test_build_heading
     parser = @RMP.new
 

data/test/test_rdoc_markup_pre_process.rb

@@ -11,7 +11,7 @@ class TestRDocMarkupPreProcess < RDoc::TestCase
     @file_name = File.basename @tempfile.path
     @dir  = File.dirname @tempfile.path
 
-    @pp = RDoc::Markup::PreProcess.new __FILE__, [@dir]
+    @pp = RDoc::Markup::PreProcess.new @tempfile.path, [@dir, File.dirname(__FILE__)]
   end
 
   def teardown
@@ -72,6 +72,18 @@ contents of a string.
     assert_equal expected, content
   end
 
+  def test_include_file_in_other_directory
+    content = nil
+    out, err = capture_io do
+      content = @pp.include_file "test.txt", '', nil
+    end
+
+    assert_empty out
+    assert_empty err
+
+    assert_equal "test file\n", content
+  end
+
   def test_handle
     text = "# :main: M\n"
     out = @pp.handle text
@@ -135,7 +147,7 @@ contents of a string.
   def test_handle_directive_blankline
     result = @pp.handle_directive '#', 'arg', 'a, b'
 
-    assert_equal "#\n", result
+    assert_equal "#:arg: a, b\n", result
   end
 
   def test_handle_directive_downcase
@@ -157,7 +169,7 @@ contents of a string.
   def test_handle_directive_arg_no_context
     result = @pp.handle_directive '', 'arg', 'a, b', nil
 
-    assert_equal "\n", result
+    assert_equal ":arg: a, b\n", result
   end
 
   def test_handle_directive_args

data/test/test_rdoc_markup_raw.rb

@@ -8,13 +8,6 @@ class TestRDocMarkupRaw < RDoc::TestCase
     @p = @RM::Raw.new
   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_push
     @p.push 'hi', 'there'
 

data/test/test_rdoc_markup_to_html.rb

@@ -288,7 +288,7 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
   end
 
   def accept_rule
-    assert_equal "<hr style=\"height: 4px\">\n", @to.res.join
+    assert_equal "<hr>\n", @to.res.join
   end
 
   def accept_verbatim
@@ -357,12 +357,12 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
     @to.code_object = RDoc::NormalClass.new 'Foo'
     @to.start_accepting
 
-    @to.accept_heading @RM::Heading.new(1, 'Hello')
+    @to.accept_heading head(1, 'Hello')
 
-    links = '<span><a href="#label-Hello">&para;</a> ' +
+    links = '<span><a href="#class-Foo-label-Hello">&para;</a> ' +
             '<a href="#documentation">&uarr;</a></span>'
 
-    assert_equal "\n<h1 id=\"label-Hello\">Hello#{links}</h1>\n",
+    assert_equal "\n<h1 id=\"class-Foo-label-Hello\">Hello#{links}</h1>\n",
                  @to.res.join
   end
 
@@ -397,6 +397,27 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
     assert_equal "\n<p>hello world</p>\n", @to.res.join
   end
 
+  def test_accept_heading_output_decoration
+    @options.output_decoration = false
+
+    @to.start_accepting
+
+    @to.accept_heading @RM::Heading.new(1, 'Hello')
+
+    assert_equal "\n<h1>Hello<span><a href=\"#label-Hello\">&para;</a> <a href=\"#documentation\">&uarr;</a></span></h1>\n", @to.res.join
+  end
+
+  def test_accept_heading_output_decoration_with_pipe
+    @options.pipe = true
+    @options.output_decoration = false
+
+    @to.start_accepting
+
+    @to.accept_heading @RM::Heading.new(1, 'Hello')
+
+    assert_equal "\n<h1>Hello</h1>\n", @to.res.join
+  end
+
   def test_accept_verbatim_parseable
     verb = @RM::Verbatim.new("class C\n", "end\n")
 
@@ -483,13 +504,13 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
   def test_convert_RDOCLINK_label_foottext
     result = @to.convert 'rdoc-label:foottext-1'
 
-    assert_equal "\n<p><a href=\"#foottext-1\">*1</a></p>\n", result
+    assert_equal "\n<p><a href=\"#foottext-1\">1</a></p>\n", result
   end
 
   def test_convert_RDOCLINK_label_footmark
     result = @to.convert 'rdoc-label:footmark-1'
 
-    assert_equal "\n<p><a href=\"#footmark-1\">^1</a></p>\n", result
+    assert_equal "\n<p><a href=\"#footmark-1\">1</a></p>\n", result
   end
 
   def test_convert_RDOCLINK_ref
@@ -501,7 +522,28 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
   def test_convert_TIDYLINK_footnote
     result = @to.convert 'text{*1}[rdoc-label:foottext-1:footmark-1]'
 
-    assert_equal "\n<p>text<a id=\"footmark-1\" href=\"#foottext-1\">*1</a></p>\n", result
+    assert_equal "\n<p>text<sup><a id=\"footmark-1\" href=\"#foottext-1\">1</a></sup></p>\n", result
+  end
+
+  def test_convert_TIDYLINK_multiple
+    result = @to.convert '{a}[http://example] {b}[http://example]'
+
+    expected = <<-EXPECTED
+
+<p><a href=\"http://example\">a</a> <a href=\"http://example\">b</a></p>
+    EXPECTED
+
+    assert_equal expected, result
+  end
+
+  def test_convert_TIDYLINK_image
+    result =
+      @to.convert '{rdoc-image:path/to/image.jpg}[http://example.com]'
+
+    expected =
+      "\n<p><a href=\"http://example.com\"><img src=\"path/to/image.jpg\"></a></p>\n"
+
+    assert_equal expected, result
   end
 
   def test_convert_TIDYLINK_rdoc_label
@@ -527,7 +569,7 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
   end
 
   def test_gen_url_rdoc_label_id
-    assert_equal '<a id="footmark-1" href="#foottext-1">example</a>',
+    assert_equal '<sup><a id="footmark-1" href="#foottext-1">example</a></sup>',
                  @to.gen_url('rdoc-label:foottext-1:footmark-1', 'example')
   end
 

data/test/test_rdoc_markup_to_html_crossref.rb

@@ -36,6 +36,13 @@ class TestRDocMarkupToHtmlCrossref < XrefTestCase
                  result
   end
 
+  def test_convert_CROSSREF_section
+    @c1.add_section 'Section'
+
+    result = @to.convert 'C1@Section'
+    assert_equal para("<a href=\"C1.html#Section\">Section at C1</a>"), result
+  end
+
   def test_convert_RDOCLINK_rdoc_ref
     result = @to.convert 'rdoc-ref:C1'
 

data/test/test_rdoc_markup_to_html_snippet.rb

@@ -626,15 +626,15 @@ This routine modifies its +comment+ parameter.
   def test_convert_RDOCLINK_label_foottext
     result = @to.convert 'rdoc-label:foottext-1'
 
-    assert_equal "<p>*1\n", result
-    assert_equal 2, @to.characters
+    assert_equal "<p>1\n", result
+    assert_equal 1, @to.characters
   end
 
   def test_convert_RDOCLINK_label_footmark
     result = @to.convert 'rdoc-label:footmark-1'
 
-    assert_equal "<p>^1\n", result
-    assert_equal 2, @to.characters
+    assert_equal "<p>1\n", result
+    assert_equal 1, @to.characters
   end
 
   def test_convert_RDOCLINK_ref

data/test/test_rdoc_markup_to_markdown.rb

@@ -354,6 +354,12 @@ words words words words
     assert_equal "C\n", result
   end
 
+  def test_convert_RDOCLINK_image
+    result = @to.convert 'rdoc-image:/path/to/image.jpg'
+
+    assert_equal "![](/path/to/image.jpg)\n", result
+  end
+
   def test_convert_TIDYLINK
     result = @to.convert \
       '{DSL}[http://en.wikipedia.org/wiki/Domain-specific_language]'

data/test/test_rdoc_method_attr.rb

@@ -2,6 +2,10 @@ require File.expand_path '../xref_test_case', __FILE__
 
 class TestRDocMethodAttr < XrefTestCase
 
+  def test_initialize_copy
+    refute_same @c1_m.full_name, @c1_m.dup.full_name
+  end
+
   def test_block_params_equal
 
     m = RDoc::MethodAttr.new(nil, 'foo')
@@ -116,6 +120,10 @@ class TestRDocMethodAttr < XrefTestCase
     assert_equal 'C1::m', @c1__m.full_name
   end
 
+  def test_is_alias_for
+    assert_equal @c2_b, @c2_a.is_alias_for
+  end
+
   def test_output_name
     assert_equal '#m',  @c1_m.output_name(@c1)
     assert_equal '::m', @c1__m.output_name(@c1)

data/test/test_rdoc_normal_class.rb

@@ -21,6 +21,11 @@ class TestRDocNormalClass < XrefTestCase
     assert_equal [c2, c1, 'Object'], c3.ancestors
   end
 
+  def test_aref
+    assert_equal 'class-C1',     @c1.aref
+    assert_equal 'class-C2::C3', @c2_c3.aref
+  end
+
   def test_direct_ancestors
     incl = RDoc::Include.new 'Incl', ''
 

data/test/test_rdoc_normal_module.rb

@@ -23,6 +23,11 @@ class TestRDocNormalModule < XrefTestCase
     assert_equal [mod2, incl.name], mod.ancestors
   end
 
+  def test_aref
+    assert_equal 'module-M1',     @m1.aref
+    assert_equal 'module-M1::M2', @m1_m2.aref
+  end
+
   def test_definition
     m = RDoc::NormalModule.new 'M'
 

data/test/test_rdoc_options.rb

@@ -15,13 +15,6 @@ class TestRDocOptions < RDoc::TestCase
     RDoc::RDoc::GENERATORS.replace @generators
   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_check_files
     skip "assumes UNIX permission model" if /mswin|mingw/ =~ RUBY_PLATFORM
 
@@ -69,21 +62,23 @@ class TestRDocOptions < RDoc::TestCase
     encoding = Object.const_defined?(:Encoding) ? 'UTF-8' : nil
 
     expected = {
-      'charset'        => 'UTF-8',
-      'encoding'       => encoding,
-      'exclude'        => [],
-      'hyperlink_all'  => false,
-      'line_numbers'   => false,
-      'main_page'      => nil,
-      'markup'         => 'rdoc',
-      'page_dir'       => nil,
-      'rdoc_include'   => [],
-      'show_hash'      => false,
-      'static_path'    => [],
-      'tab_width'      => 8,
-      'title'          => nil,
-      'visibility'     => :protected,
-      'webcvs'         => nil,
+      'charset'              => 'UTF-8',
+      'encoding'             => encoding,
+      'exclude'              => [],
+      'hyperlink_all'        => false,
+      'line_numbers'         => false,
+      'main_page'            => nil,
+      'markup'               => 'rdoc',
+      'output_decoration'    => true,
+      'page_dir'             => nil,
+      'rdoc_include'         => [],
+      'show_hash'            => false,
+      'static_path'          => [],
+      'tab_width'            => 8,
+      'template_stylesheets' => [],
+      'title'                => nil,
+      'visibility'           => :protected,
+      'webcvs'               => nil,
     }
 
     assert_equal expected, coder
@@ -533,6 +528,27 @@ rdoc_include:
     assert_empty err
 
     assert_equal Pathname(Dir.tmpdir), @options.root
+    assert_includes @options.rdoc_include, @options.root.to_s
+  end
+
+  def test_parse_tab_width
+    @options.parse %w[--tab-width=1]
+    assert_equal 1, @options.tab_width
+
+    @options.parse %w[-w2]
+    assert_equal 2, @options.tab_width
+
+    _, err = capture_io do
+      @options.parse %w[-w=2]
+    end
+
+    assert_match 'invalid options', err
+
+    _, err = capture_io do
+      @options.parse %w[-w0]
+    end
+
+    assert_match 'invalid options', err
   end
 
   def test_parse_template
@@ -586,6 +602,20 @@ rdoc_include:
     $LOAD_PATH.replace orig_LOAD_PATH
   end
 
+  def test_parse_visibility
+    @options.parse %w[--visibility=public]
+    assert_equal :public, @options.visibility
+
+    @options.parse %w[--visibility=protected]
+    assert_equal :protected, @options.visibility
+
+    @options.parse %w[--visibility=private]
+    assert_equal :private, @options.visibility
+
+    @options.parse %w[--visibility=nodoc]
+    assert_equal :nodoc, @options.visibility
+  end
+
   def test_parse_write_options
     tmpdir = File.join Dir.tmpdir, "test_rdoc_options_#{$$}"
     FileUtils.mkdir_p tmpdir
@@ -702,6 +732,15 @@ rdoc_include:
     end
 
     assert out.include?(RDoc::VERSION)
+
+    out, _ = capture_io do
+      begin
+        @options.parse %w[-v]
+      rescue SystemExit
+      end
+    end
+
+    assert out.include?(RDoc::VERSION)
   end
 
 end

data/test/test_rdoc_parser.rb

@@ -292,6 +292,16 @@ class TestRDocParser < RDoc::TestCase
     assert_nil parser
   end
 
+  def test_class_use_markup_unknown
+    content = <<-CONTENT
+# :markup: RDoc
+    CONTENT
+
+    parser = @RP.use_markup content
+
+    assert_nil parser
+  end
+
   def test_initialize
     @RP.new @top_level, @fn, '', @options, nil
 

data/test/test_rdoc_parser_c.rb

@@ -534,10 +534,6 @@ void Init_curses(){
   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
@@ -1722,7 +1718,7 @@ path_to_s(VALUE self) { }
  */
 static VALUE
 path_aref_m(int argc, VALUE *argv, VALUE str) { }
- 
+
 /*
  *  call-seq:
  *     string <=> other_string   -> -1, 0, +1 or nil
@@ -1730,6 +1726,14 @@ path_aref_m(int argc, VALUE *argv, VALUE str) { }
 static VALUE
 path_cmp_m(VALUE str1, VALUE str2) { }
 
+/*
+ *  call-seq:
+ *     str == obj    -> true or false
+ *     str === obj   -> true or false
+ */
+VALUE
+rb_str_equal(VALUE str1, VALUE str2) { }
+
 Init_pathname()
 {
     rb_cPathname = rb_define_class("Pathname", rb_cObject);
@@ -1739,6 +1743,8 @@ Init_pathname()
     rb_define_method(rb_cPathname, "[]",      path_aref_m, -1);
     rb_define_method(rb_cPathname, "slice",   path_aref_m, -1);
     rb_define_method(rb_cPathname, "<=>",     path_cmp_m, 1);
+    rb_define_method(rb_cPathname, "==",      rb_str_equal), 2);
+    rb_define_method(rb_cPathname, "===",     rb_str_equal), 2);
 }
     C
 
@@ -1771,6 +1777,12 @@ str.slice(start, length) -> new_str or nil
     spaceship = pathname.method_list.find { |m| m.name == '<=>' }
     assert_equal "string <=> other_string   -> -1, 0, +1 or nil",
                  spaceship.call_seq
+
+    equals2 = pathname.method_list.find { |m| m.name == '==' }
+    assert_match 'str == obj', equals2.call_seq
+
+    equals3 = pathname.method_list.find { |m| m.name == '===' }
+    assert_match 'str === obj', equals3.call_seq
   end
 
   def test_scan_order_dependent