rdoc 4.0.1 → 4.1.0.preview.3

data/test/test_rdoc_cross_reference.rb

@@ -19,9 +19,10 @@ class TestRDocCrossReference < XrefTestCase
   def test_METHOD_REGEXP_STR
     re = /#{RDoc::CrossReference::METHOD_REGEXP_STR}/
 
-    re =~ '==='
-
-    assert_equal '===', $&
+    %w'=== [] []= << >>'.each do |x|
+      re =~ x
+      assert_equal x, $&
+    end
   end
 
   def test_resolve_C2

data/test/test_rdoc_generator_darkfish.rb

@@ -65,21 +65,6 @@ class TestRDocGeneratorDarkfish < RDoc::TestCase
     FileUtils.rm_rf @tmpdir
   end
 
-  def assert_file path
-    assert File.file?(path), "#{path} is not a file"
-  end
-
-  def refute_file path
-    refute File.exist?(path), "#{path} exists"
-  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_generate
     top_level = @store.add_file 'file.rb'
     top_level.add_class @klass.class, @klass.name
@@ -91,16 +76,20 @@ class TestRDocGeneratorDarkfish < RDoc::TestCase
     assert_file 'table_of_contents.html'
     assert_file 'js/search_index.js'
 
+    assert_hard_link 'rdoc.css'
+    assert_hard_link 'fonts.css'
+
+    assert_hard_link 'fonts/SourceCodePro-Bold.ttf'
+    assert_hard_link 'fonts/SourceCodePro-Regular.ttf'
+
     encoding = if Object.const_defined? :Encoding then
                  Regexp.escape Encoding::UTF_8.name
                else
                  Regexp.escape 'UTF-8'
                end
 
-    assert_match(/<meta content="text\/html; charset=#{encoding}"/,
-                 File.read('index.html'))
-    assert_match(/<meta content="text\/html; charset=#{encoding}"/,
-                 File.read('Object.html'))
+    assert_match %r%<meta charset="#{encoding}">%, File.read('index.html')
+    assert_match %r%<meta charset="#{encoding}">%, File.read('Object.html')
 
     refute_match(/Ignored/, File.read('index.html'))
   end
@@ -145,6 +134,36 @@ class TestRDocGeneratorDarkfish < RDoc::TestCase
     refute_file 'image.png'
   end
 
+  def test_install_rdoc_static_file
+    src = Pathname(__FILE__)
+    dst = File.join @tmpdir, File.basename(src)
+    options = {}
+
+    @g.install_rdoc_static_file src, dst, options
+
+    assert_file dst
+
+    begin
+      assert_hard_link dst
+    rescue MiniTest::Assertion
+      return # hard links are not supported, no further tests needed
+    end
+
+    @g.install_rdoc_static_file src, dst, options
+
+    assert_hard_link dst
+  end
+
+  def test_install_rdoc_static_file_missing
+    src = Pathname(__FILE__) + 'nonexistent'
+    dst = File.join @tmpdir, File.basename(src)
+    options = {}
+
+    @g.install_rdoc_static_file src, dst, options
+
+    refute_file dst
+  end
+
   def test_setup
     @g.setup
 
@@ -183,5 +202,28 @@ class TestRDocGeneratorDarkfish < RDoc::TestCase
     assert_same template, @g.send(:template_for, partial)
   end
 
+  ##
+  # Asserts that +filename+ has a link count greater than 1 if hard links to
+  # @tmpdir are supported.
+
+  def assert_hard_link filename
+    assert_file filename
+
+    src = @g.template_dir + '_head.rhtml'
+    dst = File.join @tmpdir, 'hardlinktest'
+
+    begin
+      FileUtils.ln src, dst
+      nlink = File.stat(dst).nlink if File.identical? src, dst
+      FileUtils.rm dst
+      return if nlink == 1
+    rescue SystemCallError
+      return
+    end
+
+    assert_operator File.stat(filename).nlink, :>, 1,
+                    "#{filename} is not hard-linked"
+  end
+
 end
 

data/test/test_rdoc_generator_json_index.rb

@@ -57,17 +57,6 @@ class TestRDocGeneratorJsonIndex < RDoc::TestCase
     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_build_index
     index = @g.build_index
 

data/test/test_rdoc_generator_ri.rb

@@ -42,14 +42,6 @@ class TestRDocGeneratorRI < RDoc::TestCase
     FileUtils.rm_rf @tmpdir
   end
 
-  def assert_file path
-    assert File.file?(path), "#{path} is not a file"
-  end
-
-  def refute_file path
-    refute File.exist?(path), "#{path} exists"
-  end
-
   def test_generate
     @g.generate
 

data/test/test_rdoc_markdown.rb

@@ -1,10 +1,6 @@
 # coding: UTF-8
 
-require 'rubygems'
-require 'minitest/autorun'
-require 'pp'
-
-require 'rdoc'
+require 'rdoc/test_case'
 require 'rdoc/markup/block_quote'
 require 'rdoc/markdown'
 
@@ -14,13 +10,8 @@ class TestRDocMarkdown < RDoc::TestCase
     @RM = RDoc::Markup
 
     @parser = RDoc::Markdown.new
-  end
 
-  def mu_pp obj
-    s = ''
-    s = PP.pp obj, s
-    s.force_encoding Encoding.default_external if defined? Encoding
-    s.chomp
+    @to_html = RDoc::Markup::ToHtml.new(RDoc::Options.new, nil)
   end
 
   def test_class_parse
@@ -439,7 +430,19 @@ heading
   def test_parse_image
     doc = parse "image ![alt text](path/to/image.jpg)"
 
-    expected = doc(para("image {alt text}[path/to/image.jpg]"))
+    expected = doc(para("image rdoc-image:path/to/image.jpg"))
+
+    assert_equal expected, doc
+  end
+
+  def test_parse_image_link
+    @parser.html = true
+
+    doc = parse "[![alt text](path/to/image.jpg)](http://example.com)"
+
+    expected =
+      doc(
+        para('{rdoc-image:path/to/image.jpg}[http://example.com]'))
 
     assert_equal expected, doc
   end

data/test/test_rdoc_markdown_test.rb

@@ -15,13 +15,6 @@ class TestRDocMarkdownTest < RDoc::TestCase
     @parser = RDoc::Markdown.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_amps_and_angle_encoding
     input = File.read "#{MARKDOWN_TEST_PATH}/Amps and angle encoding.text"
 

data/test/test_rdoc_markup_attribute_manager.rb

@@ -26,6 +26,12 @@ class TestRDocMarkupAttributeManager < RDoc::TestCase
     @am.add_word_pair("{", "}", :WOMBAT)
     @wombat_on    = @am.changed_attribute_by_name([], [:WOMBAT])
     @wombat_off   = @am.changed_attribute_by_name([:WOMBAT], [])
+
+    @klass = RDoc::Markup::AttributeManager
+    @formatter = RDoc::Markup::Formatter.new @rdoc.options
+    @formatter.add_tag :BOLD, '<B>', '</B>'
+    @formatter.add_tag :EM, '<EM>', '</EM>'
+    @formatter.add_tag :TT, '<CODE>', '</CODE>'
   end
 
   def crossref(text)
@@ -44,6 +50,21 @@ class TestRDocMarkupAttributeManager < RDoc::TestCase
     #assert_equal(["cat {and} dog" ], @am.flow("cat \\{and} dog"))
   end
 
+  def test_add_html_tag
+    @am.add_html("Test", :TEST)
+    tags = @am.html_tags
+    assert_equal(6, tags.size)
+    assert(tags.has_key?("test"))
+  end
+
+  def test_add_special
+    @am.add_special "WikiWord", :WIKIWORD
+    specials = @am.special
+
+    assert_equal 1, specials.size
+    assert specials.assoc "WikiWord"
+  end
+
   def test_add_word_pair
     @am.add_word_pair '%', '&', 'percent and'
 
@@ -60,6 +81,20 @@ class TestRDocMarkupAttributeManager < RDoc::TestCase
     assert_equal "Word flags may not start with '<'", e.message
   end
 
+  def test_add_word_pair_invalid
+    assert_raises ArgumentError do
+      @am.add_word_pair("<", "<", :TEST)
+    end
+  end
+
+  def test_add_word_pair_map
+    @am.add_word_pair("x", "y", :TEST)
+
+    word_pair_map = @am.word_pair_map
+
+    assert_includes word_pair_map.keys.map { |r| r.source }, "(x)(\\S+)(y)"
+  end
+
   def test_add_word_pair_matching
     @am.add_word_pair '^', '^', 'caret'
 
@@ -151,6 +186,56 @@ class TestRDocMarkupAttributeManager < RDoc::TestCase
     assert_equal "\000x-y\000", str
   end
 
+  def test_convert_attrs_ignores_code
+    assert_equal 'foo <CODE>__send__</CODE> bar', output('foo <code>__send__</code> bar')
+  end
+
+  def test_convert_attrs_ignores_tt
+    assert_equal 'foo <CODE>__send__</CODE> bar', output('foo <tt>__send__</tt> bar')
+  end
+
+  def test_convert_attrs_preserves_double
+    assert_equal 'foo.__send__ :bar', output('foo.__send__ :bar')
+    assert_equal 'use __FILE__ to', output('use __FILE__ to')
+  end
+
+  def test_convert_attrs_does_not_ignore_after_tt
+    assert_equal 'the <CODE>IF:</CODE><EM>key</EM> directive', output('the <tt>IF:</tt>_key_ directive')
+  end
+
+  def test_escapes
+    assert_equal '<CODE>text</CODE>',   output('<tt>text</tt>')
+    assert_equal '<tt>text</tt>',       output('\\<tt>text</tt>')
+    assert_equal '<tt>',                output('\\<tt>')
+    assert_equal '<CODE><tt></CODE>',   output('<tt>\\<tt></tt>')
+    assert_equal '<CODE>\\<tt></CODE>', output('<tt>\\\\<tt></tt>')
+    assert_equal '<B>text</B>',         output('*text*')
+    assert_equal '*text*',              output('\\*text*')
+    assert_equal '\\',                  output('\\')
+    assert_equal '\\text',              output('\\text')
+    assert_equal '\\\\text',            output('\\\\text')
+    assert_equal 'text \\ text',        output('text \\ text')
+
+    assert_equal 'and <CODE>\\s</CODE> matches space',
+                 output('and <tt>\\s</tt> matches space')
+    assert_equal 'use <CODE><tt>text</CODE></tt> for code',
+                 output('use <tt>\\<tt>text</tt></tt> for code')
+    assert_equal 'use <CODE><tt>text</tt></CODE> for code',
+                 output('use <tt>\\<tt>text\\</tt></tt> for code')
+    assert_equal 'use <tt><tt>text</tt></tt> for code',
+                 output('use \\<tt>\\<tt>text</tt></tt> for code')
+    assert_equal 'use <tt><CODE>text</CODE></tt> for code',
+                 output('use \\<tt><tt>text</tt></tt> for code')
+    assert_equal 'use <CODE>+text+</CODE> for code',
+                 output('use <tt>\\+text+</tt> for code')
+    assert_equal 'use <tt><CODE>text</CODE></tt> for code',
+                 output('use \\<tt>+text+</tt> for code')
+    assert_equal 'illegal <tag>not</tag> changed',
+                 output('illegal <tag>not</tag> changed')
+    assert_equal 'unhandled <p>tag</p> unchanged',
+                 output('unhandled <p>tag</p> unchanged')
+  end
+
   def test_html_like_em_bold
     assert_equal ["cat ", @em_on, "and ", @em_to_bold, "dog", @bold_off],
                   @am.flow("cat <i>and </i><b>dog</b>")
@@ -191,6 +276,38 @@ class TestRDocMarkupAttributeManager < RDoc::TestCase
                   @am.flow("<tt>cat</tt> <i>and <b></i>dog</b>")
   end
 
+  def test_initial_html
+    html_tags = @am.html_tags
+    assert html_tags.is_a?(Hash)
+    assert_equal(5, html_tags.size)
+  end
+
+  def test_initial_word_pairs
+    word_pairs = @am.matching_word_pairs
+    assert word_pairs.is_a?(Hash)
+    assert_equal(3, word_pairs.size)
+  end
+
+  def test_mask_protected_sequence
+    def @am.str()     @str       end
+    def @am.str=(str) @str = str end
+
+    @am.str = '<code>foo</code>'
+    @am.mask_protected_sequences
+
+    assert_equal "<code>foo</code>",       @am.str
+
+    @am.str = '<code>foo\\</code>'
+    @am.mask_protected_sequences
+
+    assert_equal "<code>foo<\x04/code>", @am.str, 'escaped close'
+
+    @am.str = '<code>foo\\\\</code>'
+    @am.mask_protected_sequences
+
+    assert_equal "<code>foo\\</code>",     @am.str, 'escaped backslash'
+  end
+
   def test_protect
     assert_equal(['cat \\ dog'],
                  @am.flow('cat \\ dog'))
@@ -233,5 +350,9 @@ class TestRDocMarkupAttributeManager < RDoc::TestCase
                  @am.flow('<tt>"\n"</tt>')
   end
 
+  def output str
+    @formatter.convert_flow @am.flow str
+  end
+
 end
 

data/test/test_rdoc_markup_document.rb

@@ -8,13 +8,6 @@ class TestRDocMarkupDocument < RDoc::TestCase
     @d = @RM::Document.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_append
     @d << @RM::Paragraph.new('hi')
 

data/test/test_rdoc_markup_formatter.rb

@@ -71,20 +71,46 @@ class TestRDocMarkupFormatter < RDoc::TestCase
     @to.add_special_RDOCLINK
 
     assert_includes special_names, 'RDOCLINK'
+
+    def @to.handle_special_RDOCLINK special
+      "<#{special.text}>"
+    end
+
+    document = doc(para('{foo}[rdoc-label:bar].'))
+
+    formatted = document.accept @to
+
+    assert_equal '{foo}[<rdoc-label:bar>].', formatted
   end
 
   def test_add_special_TIDYLINK
     @to.add_special_TIDYLINK
 
     assert_includes special_names, 'TIDYLINK'
+
+    def @to.handle_special_TIDYLINK special
+      "<#{special.text}>"
+    end
+
+    document = doc(para('foo[rdoc-label:bar].'))
+
+    formatted = document.accept @to
+
+    assert_equal '<foo[rdoc-label:bar]>.', formatted
+
+    document = doc(para('{foo}[rdoc-label:bar].'))
+
+    formatted = document.accept @to
+
+    assert_equal '<{foo}[rdoc-label:bar]>.', formatted
   end
 
   def test_parse_url
     scheme, url, id = @to.parse_url 'example/foo'
 
-    assert_equal 'http',               scheme
-    assert_equal 'http://example/foo', url
-    assert_equal nil,                  id
+    assert_equal 'http',        scheme
+    assert_equal 'example/foo', url
+    assert_equal nil,           id
   end
 
   def test_parse_url_anchor

data/test/test_rdoc_markup_heading.rb

@@ -12,6 +12,15 @@ class TestRDocMarkupHeading < RDoc::TestCase
     assert_equal 'label-Hello+Friend%21', @h.aref
   end
 
+  def test_label
+    assert_equal 'label-Hello+Friend%21', @h.label
+    assert_equal 'label-Hello+Friend%21', @h.label(nil)
+
+    context = RDoc::NormalClass.new 'Foo'
+
+    assert_equal 'class-Foo-label-Hello+Friend%21', @h.label(context)
+  end
+
   def test_plain_html
     assert_equal 'Hello <strong>Friend</strong>!', @h.plain_html
   end