Break up the comment parsing to smaller module

[alpaca-tc]

I want to break up the comment parsing in watson-ruby to smaller module. There are three reasons for this.

• First, extracting comments from a file which contains compound filetype is complex.
• Second, watson-ruby can not read shebang and detect filetype without extension.
• Third, Watson's way to extract comments from a file has many incorrect detection.

They are the reasons why I present a suggestion.

---

Currently I am writing the gem called CommentExtractor. It can easily extract comments from a file as follows.

path = 'path/to/file'
if parser = CommentExtractor::Parser.for(path)
  comments = parser.parse

  comments.each do |c|
    puts "#{c.file}:#{c.line} - #{c.value}" #=> "path/to/file:2 - I am comment"
  end
end

If watson-ruby merged CommentExtractor, it becomes that easier to extract comments. Let me know if you have any opinion, suggestions or problems on my suggestion.

---

links

• CommentExtractor (wip)
• #248