@@ -2,18 +2,20 @@ module YARD class Docstring < String attr_reader :ref_tags attr_accessor :object, :line_range, :all + + META_MATCH = /^@([a-z_]+)(?:\s+(.*))?$/i def initialize(content = '', object = nil) @tag_factory = Tags::Library.new - @tags, @ref_tags = [], [] @object = object self.all = content end def replace(content) - super parse_comments(content) + @tags, @ref_tags = [], [] @all = content + super parse_comments(content) end alias all= replace @@ -138,7 +140,6 @@ module YARD def parse_comments(comments) comments = comments.split(/\r?\n/) if comments.is_a?(String) return '' if !comments || comments.empty? - meta_match = /^@(\S+)\s*(.*)/ docstring = "" indent, last_indent = comments.first[/^\s*/].length, 0 @@ -152,16 +153,16 @@ module YARD done = comments.size == index if tag_name && (((indent < orig_indent && !empty) || done) || - (indent <= last_indent && line =~ meta_match)) + (indent <= last_indent && line =~ META_MATCH)) create_tag(tag_name, tag_buf, raw_buf) tag_name, tag_buf, raw_buf = nil, '', [] orig_indent = 0 end # Found a meta tag - if line =~ meta_match + if line =~ META_MATCH orig_indent = indent - tag_name, tag_buf = $1, $2 + tag_name, tag_buf = $1, ($2 || '') raw_buf = [tag_buf.dup] elsif tag_name && indent >= orig_indent && !empty # Extra data added to the tag on the next line lib/yard/docstring.rb @@ -64,6 +64,26 @@ describe YARD::Docstring do eof doc.summary.should == "Returns a list of tags specified by +name+ or all tags if +name+ is not specified." end + + it "should only parse tags with charset [A-Za-z_]" do + doc = Docstring.new + valid = %w( @testing @valid @is_a @is_A @__ ) + invalid = %w( @ @return@ @param, @x.y @x-y ) + + log.enter_level(Logger::FATAL) do + {valid => 1, invalid => 0}.each do |tags, size| + tags.each do |tag| + class << doc + def create_tag(tag_name, *args) + add_tag Tags::Tag.new(tag_name, *args) + end + end + doc.all = tag + doc.tags(tag[1..-1]).size.should == size + end + end + end + end it "should parse reference tag into ref_tags" do doc = Docstring.new("@return (see Foo#bar)") spec/docstring_spec.rb f6432b8c2f284bbac4ece5ee1b16adf68cf60be9 Loren Segal lsegal@soen.ca http://github.com/lsegal/yard/commit/517754f4882256e91facc106f668410406fa688f 517754f4882256e91facc106f668410406fa688f 2009-07-04T12:50:43-07:00 2009-07-04T12:50:43-07:00 Only parse @tags that match the correct charset ([A-Za-z_]) 3b9e66b94a812227f1db34062cd9a27217a6c311 Loren Segal lsegal@soen.ca