rdoc 2.5.11 → 3.0

data/test/test_rdoc_method_attr.rb

@@ -0,0 +1,122 @@
+require File.expand_path '../xref_test_case', __FILE__
+
+class TestRDocMethodAttr < XrefTestCase
+
+  def test_block_params_equal
+
+    m = RDoc::MethodAttr.new(nil, 'foo')
+
+    m.block_params = ''
+    assert_equal '', m.block_params
+
+    m.block_params = 'a_var'
+    assert_equal 'a_var', m.block_params
+
+    m.block_params = '()'
+    assert_equal '', m.block_params
+
+    m.block_params = '(a_var, b_var)'
+    assert_equal 'a_var, b_var', m.block_params
+
+    m.block_params = '.to_s + "</#{element.upcase}>"'
+    assert_equal '', m.block_params
+
+    m.block_params = 'i.name'
+    assert_equal 'name', m.block_params
+
+    m.block_params = 'attr.expanded_name, attr.value'
+    assert_equal 'expanded_name, value', m.block_params
+
+    m.block_params = 'expanded_name, attr.value'
+    assert_equal 'expanded_name, value', m.block_params
+
+    m.block_params = 'attr.expanded_name, value'
+    assert_equal 'expanded_name, value', m.block_params
+
+    m.block_params = '(@base_notifier)'
+    assert_equal 'base_notifier', m.block_params
+
+    m.block_params = 'if @signal_status == :IN_LOAD'
+    assert_equal '', m.block_params
+
+    m.block_params = 'e if e.kind_of? Element'
+    assert_equal 'e', m.block_params
+
+    m.block_params = '(e, f) if e.kind_of? Element'
+    assert_equal 'e, f', m.block_params
+
+    m.block_params = 'back_path, back_name'
+    assert_equal 'back_path, back_name', m.block_params
+
+    m.block_params = '(*a[1..-1])'
+    assert_equal '*a', m.block_params
+
+    m.block_params = '@@context[:node] if defined? @@context[:node].namespace'
+    assert_equal 'context', m.block_params
+
+    m.block_params = '(result, klass.const_get(constant_name))'
+    assert_equal 'result, const', m.block_params
+
+    m.block_params = 'name.to_s if (bitmap & bit) != 0'
+    assert_equal 'name', m.block_params
+
+    m.block_params = 'line unless line.deleted'
+    assert_equal 'line', m.block_params
+
+    m.block_params = 'str + rs'
+    assert_equal 'str', m.block_params
+
+    m.block_params = 'f+rs'
+    assert_equal 'f', m.block_params
+
+    m.block_params = '[user, realm, hash[user]]'
+    assert_equal 'user, realm, hash', m.block_params
+
+    m.block_params = 'proc{|rc| rc == "rc" ? irbrc : irbrc+rc| ... }'
+    assert_equal 'proc', m.block_params
+
+    m.block_params = 'lambda { |x| x.to_i }'
+    assert_equal 'lambda', m.block_params
+
+    m.block_params = '$&'
+    assert_equal 'str', m.block_params
+
+    m.block_params = 'Inflections.instance'
+    assert_equal 'instance', m.block_params
+
+    m.block_params = 'self.class::STARTED'
+    assert_equal 'STARTED', m.block_params
+
+    m.block_params = 'Test::Unit::TestCase::STARTED'
+    assert_equal 'STARTED', m.block_params
+
+    m.block_params = 'ActiveSupport::OptionMerger.new(self, options)'
+    assert_equal 'option_merger', m.block_params
+
+    m.block_params = ', msg'
+    assert_equal '', m.block_params
+
+    m.block_params = '[size.to_s(16), term, chunk, term].join'
+    assert_equal '[size, term, chunk, term].join', m.block_params
+
+    m.block_params = 'YPath.new( path )'
+    assert_equal 'y_path', m.block_params
+
+  end
+
+  def test_find_method_or_attribute_recursive
+    inc = RDoc::Include.new 'M1', nil
+    @m1.add_include inc # M1 now includes itself
+
+    assert_nil @m1_m.find_method_or_attribute 'm'
+  end
+
+  def test_to_s
+    assert_equal 'RDoc::AnyMethod: C1#m',  @c1_m.to_s
+    assert_equal 'RDoc::AnyMethod: C2#b',  @c2_b.to_s
+    assert_equal 'RDoc::AnyMethod: C1::m', @c1__m.to_s
+  end
+
+
+end
+

data/test/test_rdoc_normal_class.rb

@@ -10,7 +10,7 @@ class TestRDocNormalClass < XrefTestCase
     sub_klass = klass.add_class RDoc::NormalClass, 'SubClass', 'Klass'
     sub_klass.add_include incl
 
-    assert_equal [incl, klass], sub_klass.ancestors
+    assert_equal [incl.name, klass], sub_klass.ancestors
   end
 
 end

data/test/test_rdoc_normal_module.rb

@@ -15,7 +15,12 @@ class TestRDocNormalModule < XrefTestCase
 
     mod.add_include incl
 
-    assert_equal [incl], mod.ancestors
+    assert_equal [incl.name], mod.ancestors
+
+    mod2 = top_level.add_module RDoc::NormalModule, 'Inc2'
+    inc2 = RDoc::Include.new 'Inc2', ''
+    mod.add_include inc2
+    assert_equal [mod2, incl.name], mod.ancestors
   end
 
   def test_module_eh

data/test/test_rdoc_options.rb

@@ -2,12 +2,182 @@ require 'rubygems'
 require 'minitest/autorun'
 require 'rdoc/options'
 
+require 'fileutils'
+require 'tmpdir'
+
 class TestRDocOptions < MiniTest::Unit::TestCase
 
   def setup
     @options = RDoc::Options.new
   end
 
+  def test_check_files
+    out, err = capture_io do
+      Dir.mktmpdir do |dir|
+        Dir.chdir dir do
+          FileUtils.touch 'unreadable'
+          FileUtils.chmod 0, 'unreadable'
+
+          @options.files = %w[nonexistent unreadable]
+
+          @options.check_files
+        end
+      end
+    end
+
+    assert_empty @options.files
+
+    assert_equal '', out
+
+    expected = <<-EXPECTED
+file 'nonexistent' not found
+file 'unreadable' not readable
+    EXPECTED
+
+    assert_equal expected, err
+  end
+
+  def test_dry_run_default
+    refute @options.dry_run
+  end
+
+  def test_encoding_default
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    assert_equal Encoding.default_external, @options.encoding
+  end
+
+  def test_parse_dash_p
+    out, err = capture_io do
+      @options.parse %w[-p]
+    end
+
+    assert @options.pipe
+    refute_match %r%^Usage: %, err
+    refute_match %r%^invalid options%, err
+
+    assert_empty out
+  end
+
+  def test_parse_dash_p_files
+    out, err = capture_io do
+      @options.parse ['-p', File.expand_path(__FILE__)]
+    end
+
+    refute @options.pipe
+    refute_match %r%^Usage: %, err
+    assert_match %r%^invalid options: -p .with files.%, err
+
+    assert_empty out
+  end
+
+  def test_parse_default
+    @options.parse []
+
+    assert_equal RDoc::Generator::Darkfish,             @options.generator
+    assert_equal 'darkfish',                            @options.template
+    assert_match %r%rdoc/generator/template/darkfish$%, @options.template_dir
+  end
+
+  def test_parse_deprecated
+    dep_hash = RDoc::Options::DEPRECATED
+    options = dep_hash.keys.sort
+
+    out, err = capture_io do
+      @options.parse options
+    end
+
+    dep_hash.each_pair do |opt, message|
+      assert_match %r%.*#{opt}.+#{message}%, err
+    end
+
+    assert_empty out
+  end
+
+  def test_parse_dry_run
+    @options.parse %w[--dry-run]
+
+    assert @options.dry_run
+  end
+
+  def test_parse_encoding
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    @options.parse %w[--encoding Big5]
+
+    assert_equal Encoding::Big5, @options.encoding
+    assert_equal 'Big5',         @options.charset
+  end
+
+  def test_parse_encoding_invalid
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    out, err = capture_io do
+      @options.parse %w[--encoding invalid]
+    end
+
+    assert_match %r%^invalid options: --encoding invalid%, err
+
+    assert_empty out
+  end
+
+  def test_parse_formatter
+    e = assert_raises OptionParser::InvalidOption do
+      @options.parse %w[--format darkfish --format ri]
+    end
+
+    assert_equal 'invalid option: --format generator already set to darkfish',
+                 e.message
+  end
+
+  def test_parse_formatter_ri
+    e = assert_raises OptionParser::InvalidOption do
+      @options.parse %w[--format darkfish --ri]
+    end
+
+    assert_equal 'invalid option: --ri generator already set to darkfish',
+                 e.message
+
+    @options = RDoc::Options.new
+
+    e = assert_raises OptionParser::InvalidOption do
+      @options.parse %w[--format darkfish -r]
+    end
+
+    assert_equal 'invalid option: -r generator already set to darkfish',
+                 e.message
+  end
+
+  def test_parse_formatter_ri_site
+    e = assert_raises OptionParser::InvalidOption do
+      @options.parse %w[--format darkfish --ri-site]
+    end
+
+    assert_equal 'invalid option: --ri-site generator already set to darkfish',
+                 e.message
+
+    @options = RDoc::Options.new
+
+    e = assert_raises OptionParser::InvalidOption do
+      @options.parse %w[--format darkfish -R]
+    end
+
+    assert_equal 'invalid option: -R generator already set to darkfish',
+                 e.message
+  end
+
+  def test_parse_help
+    out, = capture_io do
+      begin
+        @options.parse %w[--help]
+      rescue SystemExit
+      end
+    end
+
+    assert_equal 1, out.scan(/HTML generator options:/).length
+    assert_equal 1, out.scan(/ri generator options:/).  length
+  end
+
   def test_parse_ignore_invalid
     out, err = capture_io do
       @options.parse %w[--ignore-invalid --bogus]
@@ -15,6 +185,8 @@ class TestRDocOptions < MiniTest::Unit::TestCase
 
     refute_match %r%^Usage: %, err
     assert_match %r%^invalid options: --bogus%, err
+
+    assert_empty out
   end
 
   def test_parse_ignore_invalid_default
@@ -26,17 +198,21 @@ class TestRDocOptions < MiniTest::Unit::TestCase
     assert_match %r%^invalid options: --bogus%, err
 
     assert_equal 'BLAH', @options.main_page
+
+    assert_empty out
   end
 
   def test_parse_ignore_invalid_no
     out, err = capture_io do
       assert_raises SystemExit do
-        @options.parse %w[--no-ignore-invalid --bogus]
+        @options.parse %w[--no-ignore-invalid --bogus=arg --bobogus --visibility=extended]
       end
     end
 
     assert_match %r%^Usage: %, err
-    assert_match %r%^invalid option: --bogus%, err
+    assert_match %r%^invalid options: --bogus=arg, --bobogus, --visibility=extended%, err
+
+    assert_empty out
   end
 
   def test_parse_main
@@ -50,24 +226,73 @@ class TestRDocOptions < MiniTest::Unit::TestCase
     assert_equal 'MAIN', @options.main_page
   end
 
-  def test_parse_dash_p
+  def test_parse_template
     out, err = capture_io do
-      @options.parse %w[-p]
+      @options.parse %w[--template darkfish]
     end
 
-    assert @options.pipe
-    refute_match %r%^Usage: %, err
-    refute_match %r%^invalid options%, err
+    assert_empty out
+    assert_empty err
+
+    assert_equal 'darkfish', @options.template
+
+    assert_match %r%rdoc/generator/template/darkfish$%, @options.template_dir
   end
 
-  def test_parse_dash_p_files
+  def test_parse_template_nonexistent
     out, err = capture_io do
-      @options.parse %w[-p README]
+      @options.parse %w[--template NONEXISTENT]
     end
 
-    refute @options.pipe
-    refute_match %r%^Usage: %, err
-    assert_match %r%^invalid options: -p .with files.%, err
+    assert_empty out
+    assert_equal "could not find template NONEXISTENT\n", err
+
+    assert_equal 'darkfish', @options.template
+    assert_match %r%rdoc/generator/template/darkfish$%, @options.template_dir
+  end
+
+  def test_parse_template_load_path
+    orig_LOAD_PATH = $LOAD_PATH.dup
+
+    template_dir = nil
+
+    Dir.mktmpdir do |dir|
+      $LOAD_PATH << dir
+
+      template_dir = File.join dir, 'rdoc', 'generator', 'template', 'load_path'
+
+      FileUtils.mkdir_p template_dir
+
+      out, err = capture_io do
+        @options.parse %w[--template load_path]
+      end
+
+      assert_empty out
+      assert_empty err
+    end
+
+    assert_equal 'load_path',  @options.template
+    assert_equal template_dir, @options.template_dir
+  ensure
+    $LOAD_PATH.replace orig_LOAD_PATH
+  end
+
+  def test_setup_generator
+    test_generator = Object.new
+    def test_generator.setup_options(op)
+      @op = op
+    end
+
+    def test_generator.op() @op end
+
+    RDoc::RDoc::GENERATORS['TestGenerator'] = test_generator
+
+    @options.setup_generator 'TestGenerator'
+
+    assert_equal test_generator, @options.generator
+    assert_equal [test_generator], @options.generator_options
+
+    assert_equal @options, test_generator.op
   end
 
 end

data/test/test_rdoc_parser.rb

@@ -11,25 +11,6 @@ class TestRDocParser < MiniTest::Unit::TestCase
     @binary_dat = File.expand_path '../binary.dat', __FILE__
   end
 
-  def test_class_binary_eh_erb
-    erb = File.join Dir.tmpdir, "test_rdoc_parser_#{$$}.erb"
-    open erb, 'wb' do |io|
-      io.write 'blah blah <%= stuff %> <% more stuff %>'
-    end
-
-    assert @RP.binary?(erb)
-
-    erb_rb = File.join Dir.tmpdir, "test_rdoc_parser_#{$$}.erb.rb"
-    open erb_rb, 'wb' do |io|
-      io.write 'blah blah <%= stuff %>'
-    end
-
-    refute @RP.binary?(erb_rb)
-  ensure
-    File.unlink erb
-    File.unlink erb_rb if erb_rb
-  end
-
   def test_class_binary_eh_marshal
     marshal = File.join Dir.tmpdir, "test_rdoc_parser_#{$$}.marshal"
     open marshal, 'wb' do |io|
@@ -44,14 +25,14 @@ class TestRDocParser < MiniTest::Unit::TestCase
 
   def test_class_binary_japanese_text
     file_name = File.expand_path '../test.ja.txt', __FILE__
-    assert @RP.binary?(file_name)
+    refute @RP.binary?(file_name)
   end
 
   def test_class_binary_japanese_rdoc
-    skip "Encoding not implemented" unless defined? ::Encoding
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
 
     file_name = File.expand_path '../test.ja.rdoc', __FILE__
-    assert !@RP.binary?(file_name)
+    refute @RP.binary?(file_name)
   end
 
   def test_class_can_parse