rdoc 2.5.11 → 3.0

data/test/test_rdoc_parser_simple.rb

@@ -41,7 +41,6 @@ contents of a string.
     parser.scan
 
     expected = <<-TEXT.strip
-
 Regular expressions (<i>regexp</i>s) are patterns which describe the
 contents of a string.
     TEXT
@@ -49,6 +48,31 @@ contents of a string.
     assert_equal expected, @top_level.comment
   end
 
+  # RDoc stops processing comments if it finds a comment line CONTAINING
+  # '<tt>#--</tt>'. This can be used to separate external from internal
+  # comments, or to stop a comment being associated with a method,
+  # class, or module. Commenting CAN be turned back on with
+  # a line that STARTS '<tt>#++</tt>'.
+  #
+  # I've seen guys that comment their code like this:
+  #   # This method....
+  #   #-----------------
+  #   def method
+  #
+  # => either we do it only in ruby code, or we require the leading #
+  #    (to avoid conflict with rules).
+  #
+  #   TODO: require the leading #, to provide the feature in simple text files.
+  #   Note: in ruby & C code, we require '#--' & '#++' or '*--' & '*++',
+  #   to allow rules:
+  #
+  #   # this is a comment
+  #   #---
+  #   # private text
+  #   #+++
+  #   # this is a rule:
+  #   # ---
+
   def test_remove_private_comments
     parser = util_parser ''
     text = "foo\n\n--\nbar\n++\n\nbaz\n"

data/test/test_rdoc_rdoc.rb

@@ -1,13 +1,20 @@
-require 'tempfile'
-require 'tmpdir'
 require 'rubygems'
 require 'minitest/autorun'
 require 'rdoc/rdoc'
 
+require 'fileutils'
+require 'tempfile'
+require 'tmpdir'
+
 class TestRDocRDoc < MiniTest::Unit::TestCase
 
   def setup
     @rdoc = RDoc::RDoc.new
+    @rdoc.options = RDoc::Options.new
+
+    @stats = RDoc::Stats.new 0, 0
+    @rdoc.instance_variable_set :@stats, @stats
+
     @tempfile = Tempfile.new 'test_rdoc_rdoc'
   end
 
@@ -38,36 +45,6 @@ class TestRDocRDoc < MiniTest::Unit::TestCase
     assert_empty files
   end
 
-  def test_read_file_contents
-    @tempfile.write "hi everybody"
-    @tempfile.flush
-
-    assert_equal "hi everybody", @rdoc.read_file_contents(@tempfile.path)
-  end
-
-  def test_read_file_contents_encoding
-    skip "Encoding not implemented" unless defined? ::Encoding
-
-    @tempfile.write "# coding: utf-8\nhi everybody"
-    @tempfile.flush
-
-    contents = @rdoc.read_file_contents @tempfile.path
-    assert_equal "# coding: utf-8\nhi everybody", contents
-    assert_equal Encoding::UTF_8, contents.encoding
-  end
-
-  def test_read_file_contents_encoding_fancy
-    skip "Encoding not implemented" unless defined? ::Encoding
-
-    @tempfile.write "# -*- coding: utf-8; fill-column: 74 -*-\nhi everybody"
-    @tempfile.flush
-
-    contents = @rdoc.read_file_contents @tempfile.path
-    assert_equal("# -*- coding: utf-8; fill-column: 74 -*-\nhi everybody",
-                 contents)
-    assert_equal Encoding::UTF_8, contents.encoding
-  end
-
   def test_remove_unparsable
     file_list = %w[
       blah.class
@@ -95,6 +72,20 @@ class TestRDocRDoc < MiniTest::Unit::TestCase
     }
   end
 
+  def test_setup_output_dir_dry_run
+    skip "No Dir::mktmpdir, upgrade your ruby" unless Dir.respond_to? :mktmpdir
+
+    @rdoc.options.dry_run = true
+
+    Dir.mktmpdir do |d|
+      path = File.join d, 'testdir'
+
+      @rdoc.setup_output_dir path, false
+
+      refute File.exist? path
+    end
+  end
+
   def test_setup_output_dir_exists
     skip "No Dir::mktmpdir, upgrade your ruby" unless Dir.respond_to? :mktmpdir
 
@@ -148,5 +139,26 @@ class TestRDocRDoc < MiniTest::Unit::TestCase
     end
   end
 
+  def test_update_output_dir
+    skip "No Dir::mktmpdir, upgrade your ruby" unless Dir.respond_to? :mktmpdir
+
+    Dir.mktmpdir do |d|
+      @rdoc.update_output_dir d, Time.now, {}
+
+      assert File.exist? "#{d}/created.rid"
+    end
+  end
+
+  def test_update_output_dir_dry_run
+    skip "No Dir::mktmpdir, upgrade your ruby" unless Dir.respond_to? :mktmpdir
+
+    Dir.mktmpdir do |d|
+      @rdoc.options.dry_run = true
+      @rdoc.update_output_dir d, Time.now, {}
+
+      refute File.exist? "#{d}/created.rid"
+    end
+  end
+
 end
 

data/test/test_rdoc_ri_driver.rb

@@ -53,7 +53,7 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
   def test_self_dump
     util_store
 
-    out, err = capture_io do
+    out, = capture_io do
       RDoc::RI::Driver.dump @store.cache_path
     end
 
@@ -83,8 +83,8 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
     expected = @RM::Document.new(
       @RM::Rule.new(1),
       @RM::Paragraph.new('Also found in:'),
-      @RM::Verbatim.new('  ', 'ruby core', "\n",
-                        '  ', '~/.ri', "\n"))
+      @RM::Verbatim.new("ruby core\n",
+                        "~/.ri\n"))
 
     assert_equal expected, out
   end
@@ -143,7 +143,7 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
       @RM::BlankLine.new,
       @RM::Paragraph.new("Include thingy"),
       @RM::BlankLine.new,
-      @RM::Verbatim.new('  ', 'Enumerable', "\n"))
+      @RM::Verbatim.new("Enumerable\n"))
 
     assert_equal expected, out
   end
@@ -163,8 +163,8 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
       @RM::Rule.new(1),
       @RM::Heading.new(1, "Includes:"),
       @RM::Paragraph.new("(from #{@store.friendly_path})"),
-      @RM::Verbatim.new('  ', 'Inc', "\n",
-                        '  ', 'Enumerable', "\n"))
+      @RM::Verbatim.new("Inc\n",
+                        "Enumerable\n"))
 
     assert_equal expected, out
   end
@@ -195,7 +195,7 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
     expected = @RM::Document.new(
       @RM::Heading.new(1, 'Class methods:'),
       @RM::BlankLine.new,
-      @RM::Verbatim.new('  ', 'new'),
+      @RM::Verbatim.new('new'),
       @RM::BlankLine.new)
 
     assert_equal expected, out
@@ -285,7 +285,7 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
     doc = @RM::Document.new(
             @RM::Paragraph.new('hi'))
 
-    out, err = capture_io do
+    out, = capture_io do
       @driver.display doc
     end
 
@@ -295,12 +295,12 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
   def test_display_class
     util_store
 
-    out, err = capture_io do
+    out, = capture_io do
       @driver.display_class 'Foo::Bar'
     end
 
     assert_match %r%^= Foo::Bar%, out
-    assert_match %r%^\(from%, out # )
+    assert_match %r%^\(from%, out
 
     assert_match %r%^= Class methods:%, out
     assert_match %r%^  new%, out
@@ -315,7 +315,7 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
   def test_display_class_ambiguous
     util_multi_store
 
-    out, err = capture_io do
+    out, = capture_io do
       @driver.display_class 'Ambiguous'
     end
 
@@ -325,7 +325,7 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
   def test_display_class_multi_no_doc
     util_multi_store
 
-    out, err = capture_io do
+    out, = capture_io do
       @driver.display_class 'Foo::Baz'
     end
 
@@ -339,7 +339,7 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
   def test_display_class_superclass
     util_multi_store
 
-    out, err = capture_io do
+    out, = capture_io do
       @driver.display_class 'Bar'
     end
 
@@ -349,7 +349,7 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
   def test_display_class_module
     util_store
 
-    out, err = capture_io do
+    out, = capture_io do
       @driver.display_class 'Inc'
     end
 
@@ -359,7 +359,7 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
   def test_display_method
     util_store
 
-    out, err = capture_io do
+    out, = capture_io do
       @driver.display_method 'Foo::Bar#blah'
     end
 
@@ -371,7 +371,7 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
   def test_display_method_attribute
     util_store
 
-    out, err = capture_io do
+    out, = capture_io do
       @driver.display_method 'Foo::Bar#attr'
     end
 
@@ -382,7 +382,7 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
   def test_display_method_inherited
     util_multi_store
 
-    out, err = capture_io do
+    out, = capture_io do
       @driver.display_method 'Bar#inherit'
     end
 
@@ -393,7 +393,7 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
   def test_display_name_not_found_class
     util_store
 
-    out, err = capture_io do
+    out, = capture_io do
       assert_equal false, @driver.display_name('Foo::B')
     end
 
@@ -410,7 +410,7 @@ Foo::Baz
   def test_display_name_not_found_method
     util_store
 
-    out, err = capture_io do
+    out, = capture_io do
       assert_equal false, @driver.display_name('Foo::Bar#b')
     end
 
@@ -427,7 +427,7 @@ Foo::Bar#bother
   def test_display_method_params
     util_store
 
-    out, err = capture_io do
+    out, = capture_io do
       @driver.display_method 'Foo::Bar#bother'
     end
 
@@ -496,17 +496,22 @@ Foo::Bar#bother
   end
 
   def test_formatter
+    tty = Object.new
+    def tty.tty?() true; end
+
     driver = RDoc::RI::Driver.new
 
-    assert_instance_of @RM::ToAnsi, driver.formatter
+    assert_instance_of @RM::ToAnsi, driver.formatter(tty)
+
+    assert_instance_of @RM::ToBs, driver.formatter(StringIO.new)
 
     driver.instance_variable_set :@paging, true
 
-    assert_instance_of @RM::ToBs, driver.formatter
+    assert_instance_of @RM::ToBs, driver.formatter(StringIO.new)
 
     driver.instance_variable_set :@formatter_klass, @RM::ToHtml
 
-    assert_instance_of @RM::ToHtml, driver.formatter
+    assert_instance_of @RM::ToHtml, driver.formatter(tty)
   end
 
   def test_in_path_eh
@@ -531,7 +536,7 @@ Foo::Bar#bother
   def test_list_known_classes
     util_store
 
-    out, err = capture_io do
+    out, = capture_io do
       @driver.list_known_classes
     end
 

data/test/test_rdoc_ri_store.rb

@@ -65,6 +65,10 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
     assert File.file?(path), "#{path} is not a file"
   end
 
+  def refute_file path
+    refute File.exist?(path), "#{path} exists"
+  end
+
   def test_attributes
     @s.cache[:attributes]['Object'] = %w[attr]
 
@@ -94,6 +98,14 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
                  @s.class_path('Object::SubClass')
   end
 
+  def test_dry_run
+    refute @s.dry_run
+
+    @s.dry_run = true
+
+    assert @s.dry_run
+  end
+
   def test_friendly_path
     @s.path = @tmpdir
     @s.type = nil
@@ -198,7 +210,7 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
       :instance_methods => { 'Object' => %w[method] },
       :modules => %w[Object Object::SubClass],
       :ancestors => {
-        'Object'           => %w[Object],
+        'Object'           => %w[],
         'Object::SubClass' => %w[Incl Object],
       },
     }
@@ -210,6 +222,19 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
     end
   end
 
+  def test_save_cache_dry_run
+    @s.dry_run = true
+
+    @s.save_class @klass
+    @s.save_method @klass, @meth
+    @s.save_method @klass, @cmeth
+    @s.save_class @nest_klass
+
+    @s.save_cache
+
+    refute_file File.join(@tmpdir, 'cache.ri')
+  end
+
   def test_save_cache_duplicate_methods
     @s.save_method @klass, @meth
     @s.save_method @klass, @meth
@@ -226,7 +251,7 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
     assert_file File.join(@tmpdir, 'Object', 'cdesc-Object.ri')
 
     assert_cache({}, {}, { 'Object' => ['attr_accessor attr'] }, %w[Object],
-                 'Object' => %w[Object])
+                 'Object' => %w[])
 
     assert_equal @klass, @s.load_class('Object')
   end
@@ -245,6 +270,15 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
     assert_equal @klass, @s.load_class('Object')
   end
 
+  def test_save_class_dry_run
+    @s.dry_run = true
+
+    @s.save_class @klass
+
+    refute_file File.join(@tmpdir, 'Object')
+    refute_file File.join(@tmpdir, 'Object', 'cdesc-Object.ri')
+  end
+
   def test_save_class_merge
     @s.save_class @klass
 
@@ -270,7 +304,7 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
     assert_file File.join(@tmpdir, 'Object', 'cdesc-Object.ri')
 
     assert_cache({}, {}, { 'Object' => ['attr_accessor attr'] }, %w[Object],
-                 'Object' => %w[Object])
+                 'Object' => %w[])
 
     assert_equal @klass, @s.load_class('Object')
   end
@@ -296,6 +330,15 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
     assert_equal @meth, @s.load_method('Object', '#method')
   end
 
+  def test_save_method_dry_run
+    @s.dry_run = true
+
+    @s.save_method @klass, @meth
+
+    refute_file File.join(@tmpdir, 'Object')
+    refute_file File.join(@tmpdir, 'Object', 'method-i.ri')
+  end
+
   def test_save_method_nested
     @s.save_method @nest_klass, @nest_meth
 

data/test/test_rdoc_task.rb

@@ -42,7 +42,7 @@ class TestRDocTask < MiniTest::Unit::TestCase
   end
 
   def test_tasks_creation_with_custom_name_hash_will_use_default_if_an_option_isnt_given
-    rd = RDoc::Task.new(:clobber_rdoc => "rdoc:clean")
+    RDoc::Task.new(:clobber_rdoc => "rdoc:clean")
     assert Rake::Task[:rdoc]
     assert Rake::Task[:"rdoc:clean"]
     assert Rake::Task[:rerdoc]

data/test/test_rdoc_text.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require 'rubygems'
 require 'minitest/autorun'
 require 'rdoc'
@@ -9,6 +11,15 @@ class TestRDocText < MiniTest::Unit::TestCase
 
   include RDoc::Text
 
+  def test_self_encode_fallback
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    assert_equal '…',
+                 RDoc::Text::encode_fallback('…', Encoding::UTF_8,    '...')
+    assert_equal '...',
+                 RDoc::Text::encode_fallback('…', Encoding::US_ASCII, '...')
+  end
+
   def test_expand_tabs
     assert_equal("hello\n  dave",
                  expand_tabs("hello\n  dave"), 'spaces')
@@ -46,9 +57,9 @@ class TestRDocText < MiniTest::Unit::TestCase
 
   def test_flush_left
     text = <<-TEXT
-  
+
   we don't worry too much.
- 
+
   The comments associated with
     TEXT
 
@@ -65,7 +76,7 @@ The comments associated with
   def test_markup
     def formatter() RDoc::Markup::ToHtml.new end
 
-    assert_equal "<p>\nhi\n</p>\n", markup('hi')
+    assert_equal "<p>hi</p>", markup('hi').gsub("\n", '')
   end
 
   def test_normalize_comment
@@ -114,9 +125,9 @@ The comments associated with
     TEXT
 
     expected = <<-EXPECTED
-  
+
   we don't worry too much.
- 
+
   The comments associated with
     EXPECTED
 
@@ -143,15 +154,98 @@ The comments associated with
     TEXT
 
     expected = <<-EXPECTED
-  
+
    * we don't worry too much.
-  
+
    The comments associated with
-   
     EXPECTED
 
     assert_equal expected, strip_stars(text)
   end
 
+  def test_to_html_apostrophe
+    assert_equal '‘a', to_html("'a")
+    assert_equal 'a’', to_html("a'")
+
+    assert_equal '‘a’ ‘', to_html("'a' '")
+  end
+
+  def test_to_html_backslash
+    assert_equal 'S', to_html('\\S')
+  end
+
+  def test_to_html_copyright
+    assert_equal '©', to_html('(c)')
+  end
+
+  def test_to_html_dash
+    assert_equal '-',  to_html('-')
+    assert_equal '–',  to_html('--')
+    assert_equal '—',  to_html('---')
+    assert_equal '—-', to_html('----')
+  end
+
+  def test_to_html_double_backtick
+    assert_equal '“a',  to_html('``a')
+    assert_equal '“a“', to_html('``a``')
+  end
+
+  def test_to_html_double_quote
+    assert_equal '“a',  to_html('"a')
+    assert_equal '“a”', to_html('"a"')
+  end
+
+  def test_to_html_double_quote_quot
+    assert_equal '“a',  to_html('&quot;a')
+    assert_equal '“a”', to_html('&quot;a&quot;')
+  end
+
+  def test_to_html_double_tick
+    assert_equal '”a',        to_html("''a")
+    assert_equal '”a”', to_html("''a''")
+  end
+
+  def test_to_html_ellipsis
+    assert_equal '..', to_html('..')
+    assert_equal '…',  to_html('...')
+    assert_equal '.…', to_html('....')
+  end
+
+  def test_to_html_encoding
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    s = '...(c)'.encode Encoding::Shift_JIS
+
+    html = to_html s
+
+    assert_equal Encoding::Shift_JIS, html.encoding
+
+    expected = '…(c)'.encode Encoding::Shift_JIS
+
+    assert_equal expected, html
+  end
+
+  def test_to_html_html_tag
+    assert_equal '<a href="http://example">hi’s</a>',
+                 to_html('<a href="http://example">hi\'s</a>')
+  end
+
+  def test_to_html_registered_trademark
+    assert_equal '®', to_html('(r)')
+  end
+
+  def test_to_html_tt_tag
+    assert_equal '<tt>hi\'s</tt>',   to_html('<tt>hi\'s</tt>')
+    assert_equal '<tt>hi\\\'s</tt>', to_html('<tt>hi\\\\\'s</tt>')
+  end
+
+  def test_to_html_tt_tag_mismatch
+    _, err = capture_io do
+      assert_equal '<tt>hi', to_html('<tt>hi')
+    end
+
+    assert_equal "mismatched <tt> tag\n", err
+  end
+
 end