rdoc 3.10.pre.3 → 3.10

data/test/test_rdoc_options.rb

@@ -15,37 +15,112 @@ 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
+
     out, err = capture_io do
-      Dir.mktmpdir do |dir|
-        Dir.chdir dir do
-          FileUtils.touch 'unreadable'
-          FileUtils.chmod 0, 'unreadable'
+      temp_dir do
+        FileUtils.touch 'unreadable'
+        FileUtils.chmod 0, 'unreadable'
 
-          @options.files = %w[nonexistent unreadable]
+        @options.files = %w[nonexistent unreadable]
 
-          @options.check_files
-        end
+        @options.check_files
       end
     end
 
     assert_empty @options.files
 
-    assert_equal '', out
+    assert_empty out
+    assert_empty err
+  end
 
-    expected = <<-EXPECTED
-file 'nonexistent' not found
-file 'unreadable' not readable
-    EXPECTED
+  def test_check_files_warn
+    @options.verbosity = 2
 
-    assert_equal expected, err
+    out, err = capture_io do
+      @options.files = %w[nonexistent]
+
+      @options.check_files
+    end
+
+    assert_empty out
+    assert_equal "file 'nonexistent' not found\n", err
+    assert_empty @options.files
   end
 
   def test_dry_run_default
     refute @options.dry_run
   end
 
+  def test_encode_with
+    coder = {}
+    class << coder; alias add []=; end
+
+    @options.encode_with coder
+
+    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',
+      'rdoc_include'   => [],
+      'show_hash'      => false,
+      'static_path'    => [],
+      'tab_width'      => 8,
+      'title'          => nil,
+      'visibility'     => :protected,
+      'webcvs'         => nil,
+    }
+
+    assert_equal expected, coder
+  end
+
+  def test_encode_with_trim_paths
+    subdir = nil
+    coder = {}
+    class << coder; alias add []=; end
+
+    temp_dir do |dir|
+      FileUtils.mkdir 'project'
+      FileUtils.mkdir 'dir'
+      FileUtils.touch 'file'
+
+      Dir.chdir 'project' do
+        subdir = File.expand_path 'subdir'
+        FileUtils.mkdir 'subdir'
+        @options.parse %w[
+          --copy subdir
+          --copy ../file
+          --copy ../
+          --copy /
+          --include subdir
+          --include ../dir
+          --include ../
+          --include /
+        ]
+
+        @options.encode_with coder
+      end
+    end
+
+    assert_equal [subdir], coder['rdoc_include']
+
+    assert_equal [subdir], coder['static_path']
+  end
+
   def test_encoding_default
     skip "Encoding not implemented" unless Object.const_defined? :Encoding
 
@@ -66,6 +141,34 @@ file 'unreadable' not readable
     assert_equal expected, @options.generator_descriptions
   end
 
+  def test_init_with_encoding
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+    RDoc.load_yaml
+
+    @options.encoding = Encoding::IBM437
+
+    options = YAML.load YAML.dump @options
+
+    assert_equal Encoding::IBM437, options.encoding
+  end
+
+  def test_init_with_trim_paths
+    RDoc.load_yaml
+
+    yaml = <<-YAML
+--- !ruby/object:RDoc::Options
+static_path:
+- /etc
+rdoc_include:
+- /etc
+    YAML
+
+    options = YAML.load yaml
+
+    assert_empty options.rdoc_include
+    assert_empty options.static_path
+  end
+
   def test_parse_copy_files_file_relative
     file = File.basename __FILE__
     expected = File.expand_path __FILE__
@@ -376,6 +479,23 @@ file 'unreadable' not readable
     $LOAD_PATH.replace orig_LOAD_PATH
   end
 
+  def test_parse_write_options
+    tmpdir = File.join Dir.tmpdir, "test_rdoc_options_#{$$}"
+    FileUtils.mkdir_p tmpdir
+
+    Dir.chdir tmpdir do
+      e = assert_raises SystemExit do
+        @options.parse %w[--write-options]
+      end
+
+      assert_equal 0, e.status
+    
+      assert File.exist? '.rdoc_options'
+    end
+  ensure
+    FileUtils.rm_rf tmpdir
+  end
+
   def test_setup_generator
     test_generator = Class.new do
       def self.setup_options op
@@ -427,5 +547,33 @@ file 'unreadable' not readable
     refute @options.update_output_dir
   end
 
+  def test_warn
+    out, err = capture_io do
+      @options.warn "warnings off"
+    end
+
+    assert_empty out
+    assert_empty err
+
+    @options.verbosity = 2
+
+    out, err = capture_io do
+      @options.warn "warnings on"
+    end
+
+    assert_empty out
+    assert_equal "warnings on\n", err
+  end
+
+  def test_write_options
+    temp_dir do |dir|
+      @options.write_options
+    
+      assert File.exist? '.rdoc_options'
+
+      assert_equal @options, YAML.load(File.read('.rdoc_options'))
+    end
+  end
+
 end
 

data/test/test_rdoc_parser_c.rb

@@ -57,6 +57,7 @@ class TestRDocParserC < RDoc::TestCase
     @top_level = RDoc::TopLevel.new filename
     @fn = filename
     @options = RDoc::Options.new
+    @options.verbosity = 2
     @stats = RDoc::Stats.new 0
   end
 
@@ -263,6 +264,20 @@ VALUE cFoo = rb_define_class("Foo", rb_cObject);
     assert_equal "this is the Foo class", klass.comment.text
   end
 
+  def test_do_classes_struct
+    content = <<-EOF
+/* Document-class: Foo
+ * this is the Foo class
+ */
+VALUE cFoo = rb_struct_define_without_accessor(
+        "Foo", rb_cObject, foo_alloc,
+        "some", "various", "fields", NULL);
+    EOF
+
+    klass = util_get_class content, 'cFoo'
+    assert_equal "this is the Foo class", klass.comment.text
+  end
+
   def test_do_classes_class_under
     content = <<-EOF
 /* Document-class: Kernel::Foo

data/test/test_rdoc_rdoc.rb

@@ -42,6 +42,41 @@ class TestRDocRDoc < RDoc::TestCase
     assert_equal [file], @rdoc.gather_files([file, file])
   end
 
+  def test_load_options
+    temp_dir do
+      options = RDoc::Options.new
+      options.markup = 'tomdoc'
+      options.write_options
+
+      options = @rdoc.load_options
+
+      assert_equal 'tomdoc', options.markup
+    end
+  end
+
+  def test_load_options_invalid
+    temp_dir do
+      open '.rdoc_options', 'w' do |io|
+        io.write "a: !ruby.yaml.org,2002:str |\nfoo"
+      end
+
+      e = assert_raises RDoc::Error do
+        @rdoc.load_options
+      end
+
+      options_file = File.expand_path '.rdoc_options'
+      assert_equal "#{options_file} is not a valid rdoc options file", e.message
+    end
+  end
+
+  def load_options_no_file
+    temp_dir do
+      options = @rdoc.load_options
+
+      assert_kind_of RDoc::Options, options
+    end
+  end
+
   def test_normalized_file_list
     files = @rdoc.normalized_file_list [__FILE__]
 
@@ -88,8 +123,6 @@ class TestRDocRDoc < RDoc::TestCase
   end
 
   def test_setup_output_dir
-    skip "No Dir::mktmpdir, upgrade your ruby" unless Dir.respond_to? :mktmpdir
-
     Dir.mktmpdir {|d|
       path = File.join d, 'testdir'
 
@@ -103,8 +136,6 @@ class TestRDocRDoc < RDoc::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|
@@ -117,8 +148,6 @@ class TestRDocRDoc < RDoc::TestCase
   end
 
   def test_setup_output_dir_exists
-    skip "No Dir::mktmpdir, upgrade your ruby" unless Dir.respond_to? :mktmpdir
-
     Dir.mktmpdir {|path|
       open @rdoc.output_flag_file(path), 'w' do |io|
         io.puts Time.at 0
@@ -133,8 +162,6 @@ class TestRDocRDoc < RDoc::TestCase
   end
 
   def test_setup_output_dir_exists_empty_created_rid
-    skip "No Dir::mktmpdir, upgrade your ruby" unless Dir.respond_to? :mktmpdir
-
     Dir.mktmpdir {|path|
       open @rdoc.output_flag_file(path), 'w' do end
 
@@ -160,8 +187,6 @@ class TestRDocRDoc < RDoc::TestCase
   end
 
   def test_setup_output_dir_exists_not_rdoc
-    skip "No Dir::mktmpdir, upgrade your ruby" unless Dir.respond_to? :mktmpdir
-
     Dir.mktmpdir do |dir|
       e = assert_raises RDoc::Error do
         @rdoc.setup_output_dir dir, false
@@ -172,8 +197,6 @@ class TestRDocRDoc < RDoc::TestCase
   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, {}
 
@@ -182,8 +205,6 @@ class TestRDocRDoc < RDoc::TestCase
   end
 
   def test_update_output_dir_dont
-    skip "No Dir::mktmpdir, upgrade your ruby" unless Dir.respond_to? :mktmpdir
-
     Dir.mktmpdir do |d|
       @rdoc.options.update_output_dir = false
       @rdoc.update_output_dir d, Time.now, {}
@@ -193,8 +214,6 @@ class TestRDocRDoc < RDoc::TestCase
   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, {}

data/test/test_rdoc_ruby_lex.rb

@@ -50,6 +50,25 @@ STRING
     assert_equal expected, tokens
   end
 
+  def test_class_tokenize_heredoc_percent_N
+    tokens = RDoc::RubyLex.tokenize <<-'RUBY', nil
+a b <<-U
+%N
+U
+    RUBY
+
+    expected = [
+      @TK::TkIDENTIFIER.new( 0, 1,  0, 'a'),
+      @TK::TkSPACE     .new( 1, 1,  1, ' '),
+      @TK::TkIDENTIFIER.new( 2, 1,  2, 'b'),
+      @TK::TkSPACE     .new( 3, 1,  3, ' '),
+      @TK::TkSTRING    .new( 4, 1,  4, %Q{"%N\n"}),
+      @TK::TkNL        .new(13, 3, 14, "\n"),
+    ]
+
+    assert_equal expected, tokens
+  end
+
   def test_unary_minus
     ruby_lex = RDoc::RubyLex.new("-1", nil)
     assert_equal("-1", ruby_lex.token.value)

data/test/test_rdoc_top_level.rb

@@ -191,6 +191,15 @@ class TestRDocTopLevel < XrefTestCase
     assert_equal 'top_level.rb', @top_level.base_name
   end
 
+  def test_display_eh
+    refute @top_level.display?
+
+    page = RDoc::TopLevel.new 'README.txt'
+    page.parser = RDoc::Parser::Simple
+
+    assert page.display?
+  end
+
   def test_eql_eh
     top_level2 = RDoc::TopLevel.new 'path/top_level.rb'
     other_level = RDoc::TopLevel.new 'path/other_level.rb'

metadata

@@ -1,14 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rdoc
 version: !ruby/object:Gem::Version 
-  hash: 1923831871
+  hash: 19
   prerelease: 
   segments: 
   - 3
   - 10
-  - pre
-  - 3
-  version: 3.10.pre.3
+  version: "3.10"
 platform: ruby
 authors: 
 - Eric Hodel
@@ -40,7 +38,7 @@ cert_chain:
   x52qPcexcYZR7w==
   -----END CERTIFICATE-----
 
-date: 2011-10-01 00:00:00 Z
+date: 2011-10-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -150,6 +148,7 @@ extra_rdoc_files:
 - Manifest.txt
 - History.rdoc
 - LICENSE.rdoc
+- LEGAL.rdoc
 - README.rdoc
 - RI.rdoc
 - TODO.rdoc
@@ -158,6 +157,7 @@ files:
 - .autotest
 - .document
 - History.rdoc
+- LEGAL.rdoc
 - LICENSE.rdoc
 - Manifest.txt
 - README.rdoc