diff options
author | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2012-12-04 07:50:48 +0000 |
---|---|---|
committer | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2012-12-04 07:50:48 +0000 |
commit | 38b9667310d7d0cc0184c199fd870bfc8990eab4 (patch) | |
tree | 29fa1cf23637a8fa39ad3f88cb87c052df26e5b4 /lib/rdoc | |
parent | 086fce313553e31a22b95719eef34dbc7b775332 (diff) | |
download | ruby-38b9667310d7d0cc0184c199fd870bfc8990eab4.tar.gz |
* lib/rdoc/parser/changelog.rb: Added a ChangeLog parser to RDoc.
* lib/rdoc/parser.rb: ditto
* test/rdoc/test_rdoc_parser_changelog.rb: Test for above.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38178 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/rdoc')
-rw-r--r-- | lib/rdoc/parser.rb | 1 | ||||
-rw-r--r-- | lib/rdoc/parser/changelog.rb | 110 |
2 files changed, 111 insertions, 0 deletions
diff --git a/lib/rdoc/parser.rb b/lib/rdoc/parser.rb index bf9ab77218..685736fd28 100644 --- a/lib/rdoc/parser.rb +++ b/lib/rdoc/parser.rb @@ -268,6 +268,7 @@ end # simple must come first in order to show up last in the parsers list require 'rdoc/parser/simple' require 'rdoc/parser/c' +require 'rdoc/parser/changelog' require 'rdoc/parser/markdown' require 'rdoc/parser/rd' require 'rdoc/parser/ruby' diff --git a/lib/rdoc/parser/changelog.rb b/lib/rdoc/parser/changelog.rb new file mode 100644 index 0000000000..98174406ed --- /dev/null +++ b/lib/rdoc/parser/changelog.rb @@ -0,0 +1,110 @@ +require 'time' + +class RDoc::Parser::ChangeLog < RDoc::Parser + + include RDoc::Parser::Text + + parse_files_matching(/(\/|\\|\A)ChangeLog[^\/\\]*\z/) + + def create_document groups + doc = RDoc::Markup::Document.new + doc.file = @top_level + + doc << RDoc::Markup::Heading.new(1, File.basename(@file_name)) + doc << RDoc::Markup::BlankLine.new + + groups.each do |day, entries| + doc << RDoc::Markup::Heading.new(2, day) + doc << RDoc::Markup::BlankLine.new + + doc.concat create_entries entries + end + + doc + end + + def create_entries entries + out = [] + + entries.each do |entry, items| + out << RDoc::Markup::Heading.new(3, entry) + out << RDoc::Markup::BlankLine.new + + out << create_items(items) + end + + out + end + + def create_items items + list = RDoc::Markup::List.new :NOTE + + items.each do |item| + title, body = item.split /:\s*/, 2 + paragraph = RDoc::Markup::Paragraph.new body + list_item = RDoc::Markup::ListItem.new title, paragraph + list << list_item + end + + list + end + + def group_entries entries + entries.group_by do |title, body| + Time.parse(title).strftime "%Y-%m-%d" + end + end + + def parse_entries + entries = {} + entry_name = nil + entry_body = [] + + @content.each_line do |line| + case line + when /^\w.*/ then + entries[entry_name] = entry_body if entry_name + + entry_name = $& + + begin + Time.parse entry_name + rescue ArgumentError + entry_name = nil + end + + entry_body = [] + when /^(\t| {8})\*\s*(.*)/ then + entry_body << $2 + when /^(\t| {8})\s*(.*)/ then + continuation = $2 + next unless last = entry_body.last + + if last =~ /\s\z/ then + last << continuation + else + last << ' ' << continuation + end + end + end + + entries[entry_name] = entry_body if entry_name + + entries.delete nil + + entries + end + + def scan + entries = parse_entries + grouped_entries = group_entries entries + + doc = create_document grouped_entries + + @top_level.comment = doc + + @top_level + end + +end + |