mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
1325437297
* lib/rdoc/parser/ruby.rb (RDoc::Parser::Ruby): Don't parse rdoc files, reverts r24976 in favor of include directive support in C parser. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@27283 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
476 lines
11 KiB
Ruby
476 lines
11 KiB
Ruby
require 'stringio'
|
|
require 'tempfile'
|
|
require 'rubygems'
|
|
require 'minitest/unit'
|
|
require 'rdoc/options'
|
|
require 'rdoc/parser/c'
|
|
|
|
class RDoc::Parser::C
|
|
attr_accessor :classes
|
|
|
|
public :do_classes, :do_constants
|
|
end
|
|
|
|
class TestRDocParserC < MiniTest::Unit::TestCase
|
|
|
|
def setup
|
|
@tempfile = Tempfile.new self.class.name
|
|
filename = @tempfile.path
|
|
|
|
@top_level = RDoc::TopLevel.new filename
|
|
@fn = filename
|
|
@options = RDoc::Options.new
|
|
@stats = RDoc::Stats.new 0
|
|
|
|
RDoc::Parser::C.reset
|
|
RDoc::TopLevel.reset
|
|
end
|
|
|
|
def teardown
|
|
@tempfile.close
|
|
end
|
|
|
|
def test_do_classes_boot_class
|
|
content = <<-EOF
|
|
/* Document-class: Foo
|
|
* this is the Foo boot class
|
|
*/
|
|
VALUE cFoo = boot_defclass("Foo", rb_cObject);
|
|
EOF
|
|
|
|
klass = util_get_class content, 'cFoo'
|
|
assert_equal "this is the Foo boot class", klass.comment
|
|
assert_equal 'Object', klass.superclass
|
|
end
|
|
|
|
def test_do_classes_boot_class_nil
|
|
content = <<-EOF
|
|
/* Document-class: Foo
|
|
* this is the Foo boot class
|
|
*/
|
|
VALUE cFoo = boot_defclass("Foo", 0);
|
|
EOF
|
|
|
|
klass = util_get_class content, 'cFoo'
|
|
assert_equal "this is the Foo boot class", klass.comment
|
|
assert_equal nil, klass.superclass
|
|
end
|
|
|
|
def test_do_classes_class
|
|
content = <<-EOF
|
|
/* Document-class: Foo
|
|
* this is the Foo class
|
|
*/
|
|
VALUE cFoo = rb_define_class("Foo", rb_cObject);
|
|
EOF
|
|
|
|
klass = util_get_class content, 'cFoo'
|
|
assert_equal "this is the Foo class", klass.comment
|
|
end
|
|
|
|
def test_do_classes_class_under
|
|
content = <<-EOF
|
|
/* Document-class: Kernel::Foo
|
|
* this is the Foo class under Kernel
|
|
*/
|
|
VALUE cFoo = rb_define_class_under(rb_mKernel, "Foo", rb_cObject);
|
|
EOF
|
|
|
|
klass = util_get_class content, 'cFoo'
|
|
assert_equal "this is the Foo class under Kernel", klass.comment
|
|
end
|
|
|
|
def test_do_classes_module
|
|
content = <<-EOF
|
|
/* Document-module: Foo
|
|
* this is the Foo module
|
|
*/
|
|
VALUE mFoo = rb_define_module("Foo");
|
|
EOF
|
|
|
|
klass = util_get_class content, 'mFoo'
|
|
assert_equal "this is the Foo module", klass.comment
|
|
end
|
|
|
|
def test_do_classes_module_under
|
|
content = <<-EOF
|
|
/* Document-module: Kernel::Foo
|
|
* this is the Foo module under Kernel
|
|
*/
|
|
VALUE mFoo = rb_define_module_under(rb_mKernel, "Foo");
|
|
EOF
|
|
|
|
klass = util_get_class content, 'mFoo'
|
|
assert_equal "this is the Foo module under Kernel", klass.comment
|
|
end
|
|
|
|
def test_do_constants
|
|
content = <<-EOF
|
|
#include <ruby.h>
|
|
|
|
void Init_foo(){
|
|
VALUE cFoo = rb_define_class("Foo", rb_cObject);
|
|
|
|
/* 300: The highest possible score in bowling */
|
|
rb_define_const(cFoo, "PERFECT", INT2FIX(300));
|
|
|
|
/* Huzzah!: What you cheer when you roll a perfect game */
|
|
rb_define_const(cFoo, "CHEER", rb_str_new2("Huzzah!"));
|
|
|
|
/* TEST\:TEST: Checking to see if escaped colon works */
|
|
rb_define_const(cFoo, "TEST", rb_str_new2("TEST:TEST"));
|
|
|
|
/* \\: The file separator on MS Windows */
|
|
rb_define_const(cFoo, "MSEPARATOR", rb_str_new2("\\"));
|
|
|
|
/* /: The file separator on Unix */
|
|
rb_define_const(cFoo, "SEPARATOR", rb_str_new2("/"));
|
|
|
|
/* C:\\Program Files\\Stuff: A directory on MS Windows */
|
|
rb_define_const(cFoo, "STUFF", rb_str_new2("C:\\Program Files\\Stuff"));
|
|
|
|
/* Default definition */
|
|
rb_define_const(cFoo, "NOSEMI", INT2FIX(99));
|
|
|
|
rb_define_const(cFoo, "NOCOMMENT", rb_str_new2("No comment"));
|
|
|
|
/*
|
|
* Multiline comment goes here because this comment spans multiple lines.
|
|
* Multiline comment goes here because this comment spans multiple lines.
|
|
*/
|
|
rb_define_const(cFoo, "MULTILINE", INT2FIX(1));
|
|
|
|
/*
|
|
* 1: Multiline comment goes here because this comment spans multiple lines.
|
|
* Multiline comment goes here because this comment spans multiple lines.
|
|
*/
|
|
rb_define_const(cFoo, "MULTILINE_VALUE", INT2FIX(1));
|
|
|
|
/* Multiline comment goes here because this comment spans multiple lines.
|
|
* Multiline comment goes here because this comment spans multiple lines.
|
|
*/
|
|
rb_define_const(cFoo, "MULTILINE_NOT_EMPTY", INT2FIX(1));
|
|
|
|
}
|
|
EOF
|
|
|
|
@parser = util_parser content
|
|
|
|
@parser.do_classes
|
|
@parser.do_constants
|
|
|
|
klass = @parser.classes['cFoo']
|
|
assert klass
|
|
|
|
constants = klass.constants
|
|
assert !klass.constants.empty?
|
|
|
|
constants = constants.map { |c| [c.name, c.value, c.comment] }
|
|
|
|
assert_equal ['PERFECT', '300', 'The highest possible score in bowling '],
|
|
constants.shift
|
|
assert_equal ['CHEER', 'Huzzah!',
|
|
'What you cheer when you roll a perfect game '],
|
|
constants.shift
|
|
assert_equal ['TEST', 'TEST:TEST',
|
|
'Checking to see if escaped colon works '],
|
|
constants.shift
|
|
assert_equal ['MSEPARATOR', '\\',
|
|
'The file separator on MS Windows '],
|
|
constants.shift
|
|
assert_equal ['SEPARATOR', '/',
|
|
'The file separator on Unix '],
|
|
constants.shift
|
|
assert_equal ['STUFF', 'C:\\Program Files\\Stuff',
|
|
'A directory on MS Windows '],
|
|
constants.shift
|
|
assert_equal ['NOSEMI', 'INT2FIX(99)',
|
|
'Default definition '],
|
|
constants.shift
|
|
assert_equal ['NOCOMMENT', 'rb_str_new2("No comment")', ''],
|
|
constants.shift
|
|
|
|
comment = <<-EOF.chomp
|
|
Multiline comment goes here because this comment spans multiple lines.
|
|
Multiline comment goes here because this comment spans multiple lines.
|
|
EOF
|
|
assert_equal ['MULTILINE', 'INT2FIX(1)', comment], constants.shift
|
|
assert_equal ['MULTILINE_VALUE', '1', comment], constants.shift
|
|
assert_equal ['MULTILINE_NOT_EMPTY', 'INT2FIX(1)', comment], constants.shift
|
|
|
|
assert constants.empty?, constants.inspect
|
|
end
|
|
|
|
def test_find_class_comment_include
|
|
@options.rdoc_include << File.dirname(__FILE__)
|
|
|
|
content = <<-EOF
|
|
/*
|
|
* a comment for class Foo
|
|
*
|
|
* :include: test.txt
|
|
*/
|
|
void
|
|
Init_Foo(void) {
|
|
VALUE foo = rb_define_class("Foo", rb_cObject);
|
|
}
|
|
EOF
|
|
|
|
klass = util_get_class content, 'foo'
|
|
|
|
assert_equal "a comment for class Foo\n\ntest file", klass.comment
|
|
end
|
|
|
|
def test_find_class_comment_init
|
|
content = <<-EOF
|
|
/*
|
|
* a comment for class Foo
|
|
*/
|
|
void
|
|
Init_Foo(void) {
|
|
VALUE foo = rb_define_class("Foo", rb_cObject);
|
|
}
|
|
EOF
|
|
|
|
klass = util_get_class content, 'foo'
|
|
|
|
assert_equal "a comment for class Foo", klass.comment
|
|
end
|
|
|
|
def test_find_class_comment_define_class
|
|
content = <<-EOF
|
|
/*
|
|
* a comment for class Foo
|
|
*/
|
|
VALUE foo = rb_define_class("Foo", rb_cObject);
|
|
EOF
|
|
|
|
klass = util_get_class content, 'foo'
|
|
|
|
assert_equal "a comment for class Foo", klass.comment
|
|
end
|
|
|
|
def test_find_class_comment_define_class_Init_Foo
|
|
content = <<-EOF
|
|
/*
|
|
* a comment for class Foo on Init
|
|
*/
|
|
void
|
|
Init_Foo(void) {
|
|
/*
|
|
* a comment for class Foo on rb_define_class
|
|
*/
|
|
VALUE foo = rb_define_class("Foo", rb_cObject);
|
|
}
|
|
EOF
|
|
|
|
klass = util_get_class content, 'foo'
|
|
|
|
assert_equal "a comment for class Foo on Init", klass.comment
|
|
end
|
|
|
|
def test_find_class_comment_define_class_Init_Foo_no_void
|
|
content = <<-EOF
|
|
/*
|
|
* a comment for class Foo on Init
|
|
*/
|
|
void
|
|
Init_Foo() {
|
|
/*
|
|
* a comment for class Foo on rb_define_class
|
|
*/
|
|
VALUE foo = rb_define_class("Foo", rb_cObject);
|
|
}
|
|
EOF
|
|
|
|
klass = util_get_class content, 'foo'
|
|
|
|
assert_equal "a comment for class Foo on Init", klass.comment
|
|
end
|
|
|
|
def test_find_class_comment_define_class_bogus_comment
|
|
content = <<-EOF
|
|
/*
|
|
* a comment for other_function
|
|
*/
|
|
void
|
|
other_function() {
|
|
}
|
|
|
|
void
|
|
Init_Foo(void) {
|
|
VALUE foo = rb_define_class("Foo", rb_cObject);
|
|
}
|
|
EOF
|
|
|
|
klass = util_get_class content, 'foo'
|
|
|
|
assert_equal '', klass.comment
|
|
end
|
|
|
|
def test_find_body
|
|
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", 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
|
|
assert_equal '()', other_function.params
|
|
|
|
code = other_function.token_stream.first.text
|
|
|
|
assert_equal "VALUE\nother_function() ", code
|
|
end
|
|
|
|
def test_find_body_define
|
|
content = <<-EOF
|
|
/*
|
|
* a comment for other_function
|
|
*/
|
|
#define other_function rb_other_function
|
|
|
|
/* */
|
|
VALUE
|
|
rb_other_function() {
|
|
}
|
|
|
|
void
|
|
Init_Foo(void) {
|
|
VALUE foo = rb_define_class("Foo", rb_cObject);
|
|
|
|
rb_define_method(foo, "my_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
|
|
assert_equal '()', other_function.params
|
|
|
|
code = other_function.token_stream.first.text
|
|
|
|
assert_equal "#define other_function rb_other_function", code
|
|
end
|
|
|
|
def test_find_body_document_method
|
|
content = <<-EOF
|
|
/*
|
|
* Document-method: bar
|
|
* Document-method: baz
|
|
*
|
|
* a comment for bar
|
|
*/
|
|
VALUE
|
|
bar() {
|
|
}
|
|
|
|
void
|
|
Init_Foo(void) {
|
|
VALUE foo = rb_define_class("Foo", rb_cObject);
|
|
|
|
rb_define_method(foo, "bar", bar, 0);
|
|
rb_define_method(foo, "baz", bar, 0);
|
|
}
|
|
EOF
|
|
|
|
klass = util_get_class content, 'foo'
|
|
assert_equal 2, klass.method_list.length
|
|
|
|
methods = klass.method_list.sort
|
|
|
|
bar = methods.first
|
|
assert_equal 'Foo#bar', bar.full_name
|
|
assert_equal "a comment for bar", bar.comment
|
|
|
|
baz = methods.last
|
|
assert_equal 'Foo#baz', baz.full_name
|
|
assert_equal "a comment for bar", bar.comment
|
|
end
|
|
|
|
def test_define_method
|
|
content = <<-EOF
|
|
/*Method Comment! */
|
|
static VALUE
|
|
rb_io_s_read(argc, argv, io)
|
|
int argc;
|
|
VALUE *argv;
|
|
VALUE io;
|
|
{
|
|
}
|
|
|
|
void
|
|
Init_IO(void) {
|
|
/*
|
|
* a comment for class Foo on rb_define_class
|
|
*/
|
|
VALUE rb_cIO = rb_define_class("IO", rb_cObject);
|
|
rb_define_singleton_method(rb_cIO, "read", rb_io_s_read, -1);
|
|
}
|
|
EOF
|
|
|
|
klass = util_get_class content, 'rb_cIO'
|
|
read_method = klass.method_list.first
|
|
assert_equal "read", read_method.name
|
|
assert_equal "Method Comment! ", read_method.comment
|
|
end
|
|
|
|
def test_define_method_private
|
|
content = <<-EOF
|
|
/*Method Comment! */
|
|
static VALUE
|
|
rb_io_s_read(argc, argv, io)
|
|
int argc;
|
|
VALUE *argv;
|
|
VALUE io;
|
|
{
|
|
}
|
|
|
|
void
|
|
Init_IO(void) {
|
|
/*
|
|
* a comment for class Foo on rb_define_class
|
|
*/
|
|
VALUE rb_cIO = rb_define_class("IO", rb_cObject);
|
|
rb_define_private_method(rb_cIO, "read", rb_io_s_read, -1);
|
|
}
|
|
EOF
|
|
|
|
klass = util_get_class content, 'rb_cIO'
|
|
read_method = klass.method_list.first
|
|
assert_equal 'IO#read', read_method.full_name
|
|
assert_equal :private, read_method.visibility
|
|
assert_equal "Method Comment! ", read_method.comment
|
|
end
|
|
|
|
def util_get_class(content, name)
|
|
@parser = util_parser content
|
|
@parser.scan
|
|
@parser.classes[name]
|
|
end
|
|
|
|
def util_parser(content)
|
|
RDoc::Parser::C.new @top_level, @fn, content, @options, @stats
|
|
end
|
|
|
|
end
|
|
|
|
MiniTest::Unit.autorun
|