diff options
| -rw-r--r-- | ChangeLog | 5 | ||||
| -rw-r--r-- | lib/rdoc/parser/changelog.rb | 50 | ||||
| -rw-r--r-- | test/rdoc/test_rdoc_parser_changelog.rb | 92 |
3 files changed, 113 insertions, 34 deletions
@@ -1,3 +1,8 @@ +Wed Dec 5 16:06:54 2012 Eric Hodel <drbrain@segment7.net> + + * lib/rdoc/parser/changelog.rb: Parse more ChangeLog file variations. + * test/rdoc/test_rdoc_parser_changelog.rb: Test for above. + Wed Dec 5 12:17:11 2012 Naohisa Goto <ngotogenome@gmail.com> * ext/dl/lib/dl/func.rb (DL::Function#initialize, DL::Function#bind): diff --git a/lib/rdoc/parser/changelog.rb b/lib/rdoc/parser/changelog.rb index 98174406ed..a74d7418d9 100644 --- a/lib/rdoc/parser/changelog.rb +++ b/lib/rdoc/parser/changelog.rb @@ -6,6 +6,21 @@ class RDoc::Parser::ChangeLog < RDoc::Parser parse_files_matching(/(\/|\\|\A)ChangeLog[^\/\\]*\z/) + def continue_entry_body entry_body, continuation + return unless last = entry_body.last + + if last =~ /\)\s*\z/ and continuation =~ /\A\(/ then + last.sub!(/\)\s*\z/, ',') + continuation.sub!(/\A\(/, '') + end + + if last =~ /\s\z/ then + last << continuation + else + last << ' ' << continuation + end + end + def create_document groups doc = RDoc::Markup::Document.new doc.file = @top_level @@ -13,7 +28,7 @@ class RDoc::Parser::ChangeLog < RDoc::Parser doc << RDoc::Markup::Heading.new(1, File.basename(@file_name)) doc << RDoc::Markup::BlankLine.new - groups.each do |day, entries| + groups.sort_by do |day,| day end.reverse_each do |day, entries| doc << RDoc::Markup::Heading.new(2, day) doc << RDoc::Markup::BlankLine.new @@ -40,7 +55,7 @@ class RDoc::Parser::ChangeLog < RDoc::Parser list = RDoc::Markup::List.new :NOTE items.each do |item| - title, body = item.split /:\s*/, 2 + title, body = item.split(/:\s*/, 2) paragraph = RDoc::Markup::Paragraph.new body list_item = RDoc::Markup::ListItem.new title, paragraph list << list_item @@ -56,41 +71,48 @@ class RDoc::Parser::ChangeLog < RDoc::Parser end def parse_entries - entries = {} + entries = [] entry_name = nil entry_body = [] @content.each_line do |line| case line + when /^\s*$/ then + next when /^\w.*/ then - entries[entry_name] = entry_body if entry_name + entries << [entry_name, entry_body] if entry_name entry_name = $& begin - Time.parse entry_name + time = Time.parse entry_name + # HACK Ruby 1.8 does not raise ArgumentError for Time.parse "Other" + entry_name = nil unless entry_name =~ /#{time.year}/ rescue ArgumentError entry_name = nil end entry_body = [] - when /^(\t| {8})\*\s*(.*)/ then + when /^(\t| {8})?\*\s*(.*)/ then # "\t* file.c (func): ..." entry_body << $2 - when /^(\t| {8})\s*(.*)/ then - continuation = $2 - next unless last = entry_body.last + when /^(\t| {8})?\s*(\(.*)/ then # "\t(func): ..." + entry = $2 - if last =~ /\s\z/ then - last << continuation + if entry_body.last =~ /:/ then + entry_body << entry else - last << ' ' << continuation + continue_entry_body entry_body, entry end + when /^(\t| {8})?\s*(.*)/ then + continue_entry_body entry_body, $2 end end - entries[entry_name] = entry_body if entry_name + entries << [entry_name, entry_body] if entry_name - entries.delete nil + entries.reject! do |(entry,_)| + entry == nil + end entries end diff --git a/test/rdoc/test_rdoc_parser_changelog.rb b/test/rdoc/test_rdoc_parser_changelog.rb index 597b395a9f..be3b7145f3 100644 --- a/test/rdoc/test_rdoc_parser_changelog.rb +++ b/test/rdoc/test_rdoc_parser_changelog.rb @@ -28,6 +28,38 @@ class TestRDocParserChangeLog < RDoc::TestCase assert_equal parser, parser.can_parse('ChangeLog') assert_equal parser, parser.can_parse(@tempfile.path) + + assert_equal RDoc::Parser::Ruby, parser.can_parse('ChangeLog.rb') + end + + def test_continue_entry_body + parser = util_parser + + entry_body = ['a'] + + parser.continue_entry_body entry_body, 'b' + + assert_equal ['a b'], entry_body + end + + def test_continue_entry_body_empty + parser = util_parser + + entry_body = [] + + parser.continue_entry_body entry_body, '' + + assert_empty entry_body + end + + def test_continue_entry_body_function + parser = util_parser + + entry_body = ['file: (func1)'] + + parser.continue_entry_body entry_body, '(func2): blah' + + assert_equal ['file: (func1, func2): blah'], entry_body end def test_create_document @@ -60,8 +92,8 @@ class TestRDocParserChangeLog < RDoc::TestCase blank_line, head(3, 'Mon Dec 3 20:28:02 2012 Koichi Sasada <ko1@atdot.net>'), blank_line, - list(:NOTE, item('e', para('five')), item('f', para('six'))), - ) + list(:NOTE, item('e', para('five')), item('f', para('six')))) + expected.file = @top_level assert_equal expected, parser.create_document(groups) @@ -110,14 +142,13 @@ class TestRDocParserChangeLog < RDoc::TestCase def test_group_entries parser = util_parser - entries = { - 'Tue Dec 4 08:33:46 2012 Eric Hodel <drbrain@segment7.net>' => - %w[one two], - 'Tue Dec 4 08:32:10 2012 Eric Hodel <drbrain@segment7.net>' => - %w[three four], - 'Mon Dec 3 20:28:02 2012 Koichi Sasada <ko1@atdot.net>' => - %w[five six], - } + entries = [ + [ 'Tue Dec 4 08:33:46 2012 Eric Hodel <drbrain@segment7.net>', + %w[one two]], + [ 'Tue Dec 4 08:32:10 2012 Eric Hodel <drbrain@segment7.net>', + %w[three four]], + [ 'Mon Dec 3 20:28:02 2012 Koichi Sasada <ko1@atdot.net>', + %w[five six]]] expected = { '2012-12-04' => [ @@ -150,16 +181,37 @@ Other note that will be ignored ChangeLog - expected = { - 'Tue Dec 4 08:33:46 2012 Eric Hodel <drbrain@segment7.net>' => [ - 'README.EXT: Converted to RDoc format', - 'README.EXT.ja: ditto', - ], - 'Mon Dec 3 20:28:02 2012 Koichi Sasada <ko1@atdot.net>' => [ - 'compile.c (iseq_specialized_instruction): change condition of ' + - 'using `opt_send_simple\'. More method invocations can be simple.', - ], - } + expected = [ + [ 'Tue Dec 4 08:33:46 2012 Eric Hodel <drbrain@segment7.net>', + [ 'README.EXT: Converted to RDoc format', + 'README.EXT.ja: ditto']], + [ 'Mon Dec 3 20:28:02 2012 Koichi Sasada <ko1@atdot.net>', + [ 'compile.c (iseq_specialized_instruction): change condition of ' + + 'using `opt_send_simple\'. More method invocations can be simple.']]] + + assert_equal expected, parser.parse_entries + end + + def test_parse_entries_gnu + parser = util_parser <<-ChangeLog +1998-08-17 Richard Stallman <rms@gnu.org> + +* register.el (insert-register): Return nil. +(jump-to-register): Likewise. + +* sort.el (sort-subr): Return nil. + +* keyboard.c (menu_bar_items, tool_bar_items) +(Fexecute_extended_command): Deal with 'keymap' property. + ChangeLog + + expected = [ + [ '1998-08-17 Richard Stallman <rms@gnu.org>', + [ 'register.el (insert-register): Return nil.', + '(jump-to-register): Likewise.', + 'sort.el (sort-subr): Return nil.', + 'keyboard.c (menu_bar_items, tool_bar_items, ' + + 'Fexecute_extended_command): Deal with \'keymap\' property.']]] assert_equal expected, parser.parse_entries end |