rdoc 2.5.11 → 3.0

data/test/test_rdoc_context.rb

@@ -34,13 +34,38 @@ class TestRDocContext < XrefTestCase
 
     @context.add_alias as
 
-    assert_equal [as], @context.aliases
-    assert_equal [as], @context.unmatched_alias_lists['old_name']
+    assert_equal [as], @context.external_aliases
+    assert_equal [as], @context.unmatched_alias_lists['#old_name']
+  end
+
+  def test_add_alias_method_attr
+    top_level = RDoc::TopLevel.new 'file.rb'
+
+    attr = RDoc::Attr.new nil, 'old_name', 'R', ''
+
+    as = RDoc::Alias.new nil, 'old_name', 'new_name', 'comment'
+    as.record_location top_level
+    as.parent = @context
+
+    @context.add_attribute attr
+    @context.add_alias as
+
+    assert_empty @context.aliases
+    assert_empty @context.unmatched_alias_lists
+    assert_equal %w[old_name new_name], @context.attributes.map { |m| m.name }
+
+    new = @context.attributes.last
+    assert_equal top_level, new.file
   end
 
   def test_add_alias_method
+    top_level = RDoc::TopLevel.new 'file.rb'
+
     meth = RDoc::AnyMethod.new nil, 'old_name'
+    meth.singleton = false
+
     as = RDoc::Alias.new nil, 'old_name', 'new_name', 'comment'
+    as.record_location top_level
     as.parent = @context
 
     @context.add_method meth
@@ -49,6 +74,9 @@ class TestRDocContext < XrefTestCase
     assert_empty @context.aliases
     assert_empty @context.unmatched_alias_lists
     assert_equal %w[old_name new_name], @context.method_list.map { |m| m.name }
+
+    new = @context.method_list.last
+    assert_equal top_level, new.file
   end
 
   def test_add_alias_method_singleton
@@ -70,28 +98,6 @@ class TestRDocContext < XrefTestCase
     assert @context.method_list.last.singleton
   end
 
-  def test_add_alias_impl
-    meth = RDoc::AnyMethod.new nil, 'old_name'
-    meth.comment    = 'old comment'
-    meth.singleton  = false
-    meth.visibility = :private
-
-    alas = RDoc::Alias.new nil, 'old_name', 'new_name', 'new comment'
-
-    @context.add_alias_impl alas, meth
-
-    assert_equal 1, @context.method_list.length
-
-    alas_meth = @context.method_list.first
-    assert_equal 'new_name',    alas_meth.name
-    assert_equal 'new comment', alas_meth.comment
-    assert_equal false,         alas_meth.singleton
-    assert_equal meth,          alas_meth.is_alias_for
-    assert_equal :private,      alas_meth.visibility
-
-    assert_equal [alas_meth], meth.aliases
-  end
-
   def test_add_class
     @c1.add_class RDoc::NormalClass, 'Klass', 'Object'
 
@@ -152,11 +158,11 @@ class TestRDocContext < XrefTestCase
     meth = RDoc::AnyMethod.new nil, 'old_name'
 
     @context.add_alias as
-    refute_empty @context.aliases
+    refute_empty @context.external_aliases
 
     @context.add_method meth
 
-    assert_empty @context.aliases
+    assert_empty @context.external_aliases
     assert_empty @context.unmatched_alias_lists
     assert_equal %w[old_name new_name], @context.method_list.map { |m| m.name }
   end
@@ -311,6 +317,46 @@ class TestRDocContext < XrefTestCase
     assert_equal @c1__m, @c1.find_symbol('::m')
   end
 
+  def test_fully_documented_eh
+    context = RDoc::Context.new
+
+    refute context.fully_documented?
+
+    context.comment = 'hi'
+
+    assert context.fully_documented?
+
+    m = @c1_m
+
+    context.add_method m
+
+    refute context.fully_documented?
+
+    m.comment = 'hi'
+
+    assert context.fully_documented?
+
+    c = RDoc::Constant.new 'C', '0', nil
+
+    context.add_constant c
+
+    refute context.fully_documented?
+
+    c.comment = 'hi'
+
+    assert context.fully_documented?
+
+    a = RDoc::Attr.new '', 'a', 'RW', nil
+
+    context.add_attribute a
+
+    refute context.fully_documented?
+
+    a.comment = 'hi'
+
+    assert context.fully_documented?
+  end
+
   def test_spaceship
     assert_equal(-1, @c2.<=>(@c3))
     assert_equal 0,  @c2.<=>(@c2)

data/test/test_rdoc_encoding.rb

@@ -0,0 +1,145 @@
+require 'rubygems'
+require 'minitest/autorun'
+require 'rdoc'
+require 'rdoc/encoding'
+
+require 'tempfile'
+
+class TestRDocEncoding < MiniTest::Unit::TestCase
+
+  def setup
+    @tempfile = Tempfile.new 'test_rdoc_encoding'
+  end
+
+  def test_class_read_file
+    @tempfile.write "hi everybody"
+    @tempfile.flush
+
+    assert_equal "hi everybody", RDoc::Encoding.read_file(@tempfile.path, nil)
+  end
+
+  def test_class_read_file_encoding
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    expected = "# coding: utf-8\nhi everybody"
+
+    @tempfile.write expected
+    @tempfile.flush
+
+    # FIXME 1.9 fix on windoze
+    expected.gsub!("\n", "\r\n") if RUBY_VERSION =~ /^1.9/ && RUBY_PLATFORM =~ /mswin|mingw/
+
+    contents = RDoc::Encoding.read_file @tempfile.path, Encoding::UTF_8
+    assert_equal expected, contents
+    assert_equal Encoding::UTF_8, contents.encoding
+  end
+
+  def test_class_read_file_encoding_convert
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    content = ""
+    content.encode! 'ISO-8859-1'
+    content << "# coding: ISO-8859-1\nhi \xE9verybody"
+
+    @tempfile.write content
+    @tempfile.flush
+
+    contents = RDoc::Encoding.read_file @tempfile.path, Encoding::UTF_8
+    assert_equal Encoding::UTF_8, contents.encoding
+    assert_equal "# coding: ISO-8859-1\nhi \u00e9verybody", contents.sub("\r", '')
+  end
+
+  def test_class_read_file_encoding_fancy
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    expected = "# -*- coding: utf-8; fill-column: 74 -*-\nhi everybody"
+    expected.encode! Encoding::UTF_8
+
+    @tempfile.write expected
+    @tempfile.flush
+
+    # FIXME 1.9 fix on windoze
+    expected.gsub!("\n", "\r\n") if RUBY_VERSION =~ /^1.9/ && RUBY_PLATFORM =~ /win32|mingw32/
+
+    contents = RDoc::Encoding.read_file @tempfile.path, Encoding::UTF_8
+    assert_equal expected, contents
+    assert_equal Encoding::UTF_8, contents.encoding
+  end
+
+  def test_class_read_file_encoding_guess
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    path = File.expand_path '../test.ja.txt', __FILE__
+    content = RDoc::Encoding.read_file path, Encoding::UTF_8
+
+    assert_equal Encoding::UTF_8, content.encoding
+  end
+
+  def test_class_read_file_encoding_with_signature
+    skip "Encoding not implemented" unless defined? ::Encoding
+
+    @tempfile.write "\xEF\xBB\xBFhi everybody"
+    @tempfile.flush
+
+    bug3360 = '[ruby-dev:41452]'
+    content = RDoc::Encoding.read_file @tempfile.path, Encoding::UTF_8
+    assert_equal Encoding::UTF_8, content.encoding, bug3360
+    assert_equal "hi everybody", content, bug3360
+  end
+
+  def test_class_set_encoding
+    s = "# coding: UTF-8\n"
+    RDoc::Encoding.set_encoding s
+
+    # sanity check for 1.8
+
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    assert_equal Encoding::UTF_8, s.encoding
+
+    s = "#!/bin/ruby\n# coding: UTF-8\n"
+    RDoc::Encoding.set_encoding s
+
+    assert_equal Encoding::UTF_8, s.encoding
+
+    s = "<?xml version='1.0' encoding='UTF-8'?>\n"
+    expected = s.encoding
+    RDoc::Encoding.set_encoding s
+
+    assert_equal Encoding::UTF_8, s.encoding
+
+    s = "<?xml version='1.0' encoding=\"UTF-8\"?>\n"
+    expected = s.encoding
+    RDoc::Encoding.set_encoding s
+
+    assert_equal Encoding::UTF_8, s.encoding
+  end
+
+  def test_class_set_encoding_bad
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    s = ""
+    expected = s.encoding
+    RDoc::Encoding.set_encoding s
+
+    assert_equal expected, s.encoding
+
+    s = "# vim:set fileencoding=utf-8:\n"
+    expected = s.encoding
+    RDoc::Encoding.set_encoding s
+
+    assert_equal expected, s.encoding
+
+    s = "# vim:set fileencoding=utf-8:\n"
+    expected = s.encoding
+    RDoc::Encoding.set_encoding s
+
+    assert_equal expected, s.encoding
+
+    assert_raises ArgumentError do
+      RDoc::Encoding.set_encoding "# -*- encoding: undecided -*-\n"
+    end
+  end
+
+end
+

data/test/test_rdoc_generator_darkfish.rb

@@ -0,0 +1,119 @@
+require 'minitest/autorun'
+require 'rdoc/rdoc'
+require 'rdoc/generator/darkfish'
+require 'tmpdir'
+require 'fileutils'
+
+class TestRDocGeneratorDarkfish < MiniTest::Unit::TestCase
+
+  def setup
+    @pwd = Dir.pwd
+    @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
+
+    @tmpdir = File.join Dir.tmpdir, "test_rdoc_generator_darkfish_#{$$}"
+    FileUtils.mkdir_p @tmpdir
+    Dir.chdir @tmpdir
+    @options.op_dir = @tmpdir
+    @options.generator = RDoc::Generator::Darkfish
+
+    $LOAD_PATH.each do |path|
+      darkfish_dir = File.join path, 'rdoc/generator/template/darkfish'
+      next unless File.directory? darkfish_dir
+      @options.template_dir = darkfish_dir
+      break
+    end
+
+    rd = RDoc::RDoc.new
+    rd.options = @options
+    RDoc::RDoc.current = rd
+
+    @g = @options.generator.new @options
+
+    rd.generator = @g
+
+    @top_level = RDoc::TopLevel.new 'file.rb'
+    @klass = @top_level.add_class RDoc::NormalClass, 'Object'
+    @meth = RDoc::AnyMethod.new nil, 'method'
+    @meth_bang = RDoc::AnyMethod.new nil, 'method!'
+    @attr = RDoc::Attr.new nil, 'attr', 'RW', ''
+
+    @klass.add_method @meth
+    @klass.add_method @meth_bang
+    @klass.add_attribute @attr
+  end
+
+  def teardown
+    $LOAD_PATH.shift
+    Dir.chdir @pwd
+    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
+    top_level = RDoc::TopLevel.new 'file.rb'
+    top_level.add_class @klass.class, @klass.name
+
+    @g.generate [top_level]
+
+    assert_file 'index.html'
+    assert_file 'Object.html'
+    assert_file 'file_rb.html'
+
+    encoding = if Object.const_defined? :Encoding then
+                 Regexp.escape Encoding.default_external.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(/<meta content="text\/html; charset=#{encoding}"/,
+                 File.read('file_rb.html'))
+  end
+
+  def test_generate_dry_run
+    @options.dry_run = true
+    top_level = RDoc::TopLevel.new 'file.rb'
+    top_level.add_class @klass.class, @klass.name
+
+    @g.generate [top_level]
+
+    refute_file 'index.html'
+    refute_file 'Object.html'
+    refute_file 'file_rb.html'
+  end
+
+  def test_template_for
+    classpage = Pathname.new @options.template_dir + '/classpage.rhtml'
+
+    template = @g.send(:template_for, classpage)
+    assert_kind_of RDoc::ERBIO, template
+
+    assert_same template, @g.send(:template_for, classpage)
+  end
+
+  def test_template_for_dry_run
+    classpage = Pathname.new @options.template_dir + '/classpage.rhtml'
+
+    template = @g.send(:template_for, classpage)
+    assert_kind_of ERB, template
+
+    assert_same template, @g.send(:template_for, classpage)
+  end
+
+end
+

data/test/test_rdoc_generator_ri.rb

@@ -1,21 +1,23 @@
 require 'rubygems'
 require 'minitest/autorun'
 require 'rdoc/rdoc'
+require 'rdoc/generator/ri'
 require 'tmpdir'
 require 'fileutils'
 
 class TestRDocGeneratorRI < MiniTest::Unit::TestCase
 
   def setup
+    @options = RDoc::Options.new
+
     @pwd = Dir.pwd
     RDoc::TopLevel.reset
 
     @tmpdir = File.join Dir.tmpdir, "test_rdoc_generator_ri_#{$$}"
     FileUtils.mkdir_p @tmpdir
     Dir.chdir @tmpdir
-    options = RDoc::Options.new
 
-    @g = RDoc::Generator::RI.new options
+    @g = RDoc::Generator::RI.new @options
 
     @top_level = RDoc::TopLevel.new 'file.rb'
     @klass = @top_level.add_class RDoc::NormalClass, 'Object'
@@ -37,6 +39,10 @@ class TestRDocGeneratorRI < 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_generate
     top_level = RDoc::TopLevel.new 'file.rb'
     top_level.add_class @klass.class, @klass.name
@@ -52,5 +58,19 @@ class TestRDocGeneratorRI < MiniTest::Unit::TestCase
     assert_file File.join(@tmpdir, 'Object', 'method%21-i.ri')
   end
 
+  def test_generate_dry_run
+    @options.dry_run = true
+    @g = RDoc::Generator::RI.new @options
+
+    top_level = RDoc::TopLevel.new 'file.rb'
+    top_level.add_class @klass.class, @klass.name
+
+    @g.generate nil
+
+    refute_file File.join(@tmpdir, 'cache.ri')
+
+    refute_file File.join(@tmpdir, 'Object')
+  end
+
 end