rdoc 4.0.0 → 4.0.1

data/test/test_rdoc_code_object.rb

@@ -229,6 +229,14 @@ class TestRDocCodeObject < XrefTestCase
     assert_equal 5, @c1_m.offset
   end
 
+  def test_options
+    assert_kind_of RDoc::Options, @co.options
+
+    @co.store = @store
+
+    assert_same @options, @co.options
+  end
+
   def test_parent_file_name
     assert_equal '(unknown)', @co.parent_file_name
     assert_equal 'xref_data.rb', @c1.parent_file_name

data/test/test_rdoc_markup_to_html.rb

@@ -256,7 +256,7 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
   end
 
   def accept_paragraph_break
-    assert_equal "\n<p>hello<br>\nworld</p>\n", @to.res.join
+    assert_equal "\n<p>hello<br> world</p>\n", @to.res.join
   end
 
   def accept_paragraph_i
@@ -389,6 +389,14 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
     assert_equal "\n<h1 id=\"label-Hello\">Hello</h1>\n", @to.res.join
   end
 
+  def test_accept_paragraph_newline
+    @to.start_accepting
+
+    @to.accept_paragraph para("hello\n", "world\n")
+
+    assert_equal "\n<p>hello world</p>\n", @to.res.join
+  end
+
   def test_accept_verbatim_parseable
     verb = @RM::Verbatim.new("class C\n", "end\n")
 
@@ -422,6 +430,24 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
     assert_equal expected, @to.res.join
   end
 
+  def test_accept_verbatim_pipe
+    @options.pipe = true
+
+    verb = @RM::Verbatim.new("1 + 1\n")
+    verb.format = :ruby
+
+    @to.start_accepting
+    @to.accept_verbatim verb
+
+    expected = <<-EXPECTED
+
+<pre><code>1 + 1
+</code></pre>
+    EXPECTED
+
+    assert_equal expected, @to.res.join
+  end
+
   def test_accept_verbatim_ruby
     verb = @RM::Verbatim.new("1 + 1\n")
     verb.format = :ruby

data/test/test_rdoc_options.rb

@@ -372,6 +372,20 @@ rdoc_include:
     assert_equal 1, out.scan(/test generator options:/).length
   end
 
+  def test_parse_format_for_extra_generator
+    RDoc::RDoc::GENERATORS['test'] = Class.new do
+      def self.setup_options options
+        op = options.option_parser
+
+        op.separator 'test generator options:'
+      end
+    end
+
+    @options.setup_generator 'test'
+
+    assert_equal @options.generator_name, 'test'
+  end
+
   def test_parse_ignore_invalid
     out, err = capture_io do
       @options.parse %w[--ignore-invalid --bogus]
@@ -409,6 +423,39 @@ rdoc_include:
     assert_empty out
   end
 
+  def test_parse_ignore_invalid_no_quiet
+    out, err = capture_io do
+      assert_raises SystemExit do
+        @options.parse %w[--quiet --no-ignore-invalid --bogus=arg --bobogus --visibility=extended]
+      end
+    end
+
+    refute_match %r%^Usage: %, err
+    assert_match %r%^invalid options: --bogus=arg, --bobogus, --visibility=extended%, err
+
+    assert_empty out
+  end
+
+  def test_ignore_needless_arg
+    out, err = capture_io do
+      @options.parse %w[--ri=foo]
+    end
+
+    assert_match %r%^invalid options: --ri=foo%, err
+
+    assert_empty out
+  end
+
+  def test_ignore_missing_arg
+    out, err = capture_io do
+      @options.parse %w[--copy-files]
+    end
+
+    assert_match %r%^invalid options: --copy-files%, err
+
+    assert_empty out
+  end
+
   def test_parse_main
     out, err = capture_io do
       @options.parse %w[--main MAIN]
@@ -468,6 +515,13 @@ rdoc_include:
     end
   end
 
+  def test_parse_ri_site
+    @options.parse %w[--ri-site]
+
+    assert_equal RDoc::Generator::RI,      @options.generator
+    assert_equal RDoc::RI::Paths.site_dir, @options.op_dir
+  end
+
   def test_parse_root
     assert_equal Pathname(Dir.pwd), @options.root
 
@@ -639,5 +693,16 @@ rdoc_include:
     end
   end
 
+  def test_version
+    out, _ = capture_io do
+      begin
+        @options.parse %w[--version]
+      rescue SystemExit
+      end
+    end
+
+    assert out.include?(RDoc::VERSION)
+  end
+
 end
 

data/test/test_rdoc_parser.rb

@@ -110,6 +110,21 @@ class TestRDocParser < RDoc::TestCase
     end
   end
 
+  def test_class_for_modeline
+    temp_dir do
+      content = "# -*- rdoc -*-\n= NEWS\n"
+
+      open 'NEWS', 'w' do |io| io.write content end
+      app = @store.add_file 'NEWS'
+
+      parser = @RP.for app, 'NEWS', content, @options, :stats
+
+      assert_kind_of RDoc::Parser::Simple, parser
+
+      assert_equal "= NEWS\n", parser.content
+    end
+  end
+
   def test_can_parse_modeline
     readme_ext = File.join Dir.tmpdir, "README.EXT.#{$$}"
 

data/test/test_rdoc_parser_c.rb

@@ -1000,6 +1000,36 @@ init_gi_repository (void)
     assert_equal 2, klass.method_list.length
   end
 
+  def test_find_body_cast
+    content = <<-EOF
+/*
+ * a comment for other_function
+ */
+VALUE
+other_function() {
+}
+
+void
+Init_Foo(void) {
+    VALUE foo = rb_define_class("Foo", rb_cObject);
+
+    rb_define_method(foo, "my_method", (METHOD)other_function, 0);
+}
+    EOF
+
+    klass = util_get_class content, 'foo'
+    other_function = klass.method_list.first
+
+    assert_equal 'my_method', other_function.name
+    assert_equal "a comment for other_function",
+                 other_function.comment.text
+    assert_equal '()', other_function.params
+
+    code = other_function.token_stream.first.text
+
+    assert_equal "VALUE\nother_function() {\n}", code
+  end
+
   def test_find_body_define
     content = <<-EOF
 #define something something_else
@@ -1669,6 +1699,80 @@ void Init(void) {
     assert_equal expected, @store.c_singleton_class_variables
   end
 
+  def test_scan_method_copy
+    parser = util_parser <<-C
+/*
+ *  call-seq:
+ *    pathname.to_s    -> string
+ *    pathname.to_path -> string
+ *
+ *  Return the path as a String.
+ *
+ *  to_path is implemented so Pathname objects are usable with File.open, etc.
+ */
+static VALUE
+path_to_s(VALUE self) { }
+
+/*
+ *  call-seq:
+ *     str[index]               -> new_str or nil
+ *     str[start, length]       -> new_str or nil
+ *     str.slice(index)         -> new_str or nil
+ *     str.slice(start, length) -> new_str or nil
+ */
+static VALUE
+path_aref_m(int argc, VALUE *argv, VALUE str) { }
+ 
+/*
+ *  call-seq:
+ *     string <=> other_string   -> -1, 0, +1 or nil
+ */
+static VALUE
+path_cmp_m(VALUE str1, VALUE str2) { }
+
+Init_pathname()
+{
+    rb_cPathname = rb_define_class("Pathname", rb_cObject);
+
+    rb_define_method(rb_cPathname, "to_s",    path_to_s, 0);
+    rb_define_method(rb_cPathname, "to_path", path_to_s, 0);
+    rb_define_method(rb_cPathname, "[]",      path_aref_m, -1);
+    rb_define_method(rb_cPathname, "slice",   path_aref_m, -1);
+    rb_define_method(rb_cPathname, "<=>",     path_cmp_m, 1);
+}
+    C
+
+    parser.scan
+
+    pathname = @store.classes_hash['Pathname']
+
+    to_path = pathname.method_list.find { |m| m.name == 'to_path' }
+    assert_equal "pathname.to_path -> string", to_path.call_seq
+
+    to_s = pathname.method_list.find { |m| m.name == 'to_s' }
+    assert_equal "pathname.to_s    -> string", to_s.call_seq
+
+    index_expected = <<-EXPECTED.chomp
+str[index]               -> new_str or nil
+str[start, length]       -> new_str or nil
+    EXPECTED
+
+    index = pathname.method_list.find { |m| m.name == '[]' }
+    assert_equal index_expected, index.call_seq, '[]'
+
+    slice_expected = <<-EXPECTED.chomp
+str.slice(index)         -> new_str or nil
+str.slice(start, length) -> new_str or nil
+    EXPECTED
+
+    slice = pathname.method_list.find { |m| m.name == 'slice' }
+    assert_equal slice_expected, slice.call_seq
+
+    spaceship = pathname.method_list.find { |m| m.name == '<=>' }
+    assert_equal "string <=> other_string   -> -1, 0, +1 or nil",
+                 spaceship.call_seq
+  end
+
   def test_scan_order_dependent
     parser = util_parser <<-C
 void a(void) {

data/test/test_rdoc_parser_ruby.rb

@@ -2780,6 +2780,30 @@ end
     assert c.documented?
   end
 
+  def test_scan_duplicate_module
+    content = <<-CONTENT
+# comment a
+module Foo
+end
+
+# comment b
+module Foo
+end
+    CONTENT
+
+    util_parser content
+
+    @parser.scan
+
+    foo = @top_level.modules.first
+
+    expected = [
+      RDoc::Comment.new('comment b', @top_level)
+    ]
+
+    assert_equal expected, foo.comment_location.map { |c, l| c }
+  end
+
   def test_scan_meta_method_block
     content = <<-CONTENT
 class C

data/test/test_rdoc_rdoc.rb

@@ -162,6 +162,23 @@ class TestRDocRDoc < RDoc::TestCase
     end
   end
 
+  def test_parse_file_binary
+    @rdoc.store = RDoc::Store.new
+
+    root = File.dirname __FILE__
+
+    @rdoc.options.root = Pathname root
+
+    out, err = capture_io do
+      Dir.chdir root do
+        assert_nil @rdoc.parse_file 'binary.dat'
+      end
+    end
+
+    assert_empty out
+    assert_empty err
+  end
+
   def test_parse_file_page_dir
     @rdoc.store = RDoc::Store.new
 

data/test/test_rdoc_ri_driver.rb

@@ -939,7 +939,10 @@ Foo::Bar#bother
     tty = Object.new
     def tty.tty?() true; end
 
-    driver = RDoc::RI::Driver.new
+    @options.delete :use_stdout
+    @options.delete :formatter
+
+    driver = RDoc::RI::Driver.new @options
 
     assert_instance_of @RM::ToAnsi, driver.formatter(tty)
 

data/test/test_rdoc_ruby_lex.rb

@@ -162,6 +162,18 @@ Line 2
     assert_equal expected, tokens
   end
 
+  def test_class_tokenize_heredoc_missing_end
+    e = assert_raises RDoc::RubyLex::Error do
+      RDoc::RubyLex.tokenize <<-'RUBY', nil
+>> string1 = <<-TXT
+>" That's swell
+>" TXT
+      RUBY
+    end
+
+    assert_equal 'Missing terminating TXT for string', e.message
+  end
+
   def test_class_tokenize_heredoc_percent_N
     tokens = RDoc::RubyLex.tokenize <<-'RUBY', nil
 a b <<-U

data/test/test_rdoc_servlet.rb

@@ -23,7 +23,9 @@ class TestRDocServlet < RDoc::TestCase
     @stores = {}
     @cache  = Hash.new { |hash, store| hash[store] = {} }
 
-    @s = RDoc::Servlet.new @server, @stores, @cache
+    @extra_dirs = [File.join(@tempdir, 'extra1'), File.join(@tempdir, 'extra2')]
+
+    @s = RDoc::Servlet.new @server, @stores, @cache, nil, @extra_dirs
 
     @req = WEBrick::HTTPRequest.new :Logger => nil
     @res = WEBrick::HTTPResponse.new :HTTPVersion => '1.0'
@@ -298,8 +300,13 @@ class TestRDocServlet < RDoc::TestCase
 
   def test_installed_docs
     touch_system_cache_path
+    touch_extra_cache_path
 
     expected = [
+      ['My Extra Documentation', 'extra-1/', true, :extra,
+        @extra_dirs[0]],
+      ['Extra Documentation', 'extra-2/', false, :extra,
+        @extra_dirs[1]],
       ['Ruby Documentation', 'ruby/', true,  :system,
         @system_dir],
       ['Site Documentation', 'site/', false, :site,
@@ -329,6 +336,8 @@ class TestRDocServlet < RDoc::TestCase
     paths = @s.ri_paths
 
     expected = [
+      [@extra_dirs[0],                 :extra],
+      [@extra_dirs[1],                 :extra],
       [@system_dir,                    :system],
       [File.join(@base, 'site'),       :site],
       [RDoc::RI::Paths::HOMEDIR,       :home],
@@ -347,6 +356,7 @@ class TestRDocServlet < RDoc::TestCase
 
   def test_root_search
     touch_system_cache_path
+    touch_extra_cache_path
 
     @s.root_search @req, @res
 
@@ -359,12 +369,16 @@ class TestRDocServlet < RDoc::TestCase
     expected = {
       'index' => {
         'searchIndex' => %w[
+          My\ Extra\ Documentation
           Ruby\ Documentation
         ],
         'longSearchIndex' => %w[
+          My\ Extra\ Documentation
           Ruby\ Documentation
         ],
         'info' => [
+          ['My Extra Documentation', '', @extra_dirs[0], '',
+            'My Extra Documentation'],
           ['Ruby Documentation', '', 'ruby', '',
             'Documentation for the Ruby standard library'],
         ],
@@ -454,6 +468,13 @@ class TestRDocServlet < RDoc::TestCase
     assert_equal :site, store.type
   end
 
+  def test_store_for_extra
+    store = @s.store_for 'extra-1'
+
+    assert_equal @extra_dirs.first, store.path
+    assert_equal :extra, store.type
+  end
+
   def touch_system_cache_path
     store = RDoc::Store.new @system_dir
     store.title = 'Standard Library Documentation'
@@ -463,5 +484,14 @@ class TestRDocServlet < RDoc::TestCase
     store.save
   end
 
+  def touch_extra_cache_path
+    store = RDoc::Store.new @extra_dirs.first
+    store.title = 'My Extra Documentation'
+
+    FileUtils.mkdir_p File.dirname store.cache_path
+
+    store.save
+  end
+
 end