class YARD::Tags::DefaultFactory
Constants
- TYPELIST_CLOSING_CHARS
- TYPELIST_OPENING_CHARS
Public Instance Methods
Source
# File lib/yard/tags/default_factory.rb, line 13 def parse_tag(tag_name, text) Tag.new(tag_name, text.strip) end
Parses tag text and creates a new tag with descriptive text
@param tag_name the name of the tag to parse @param [String] text the raw tag text @return [Tag] a tag object with the tag_name and text values filled
Source
# File lib/yard/tags/default_factory.rb, line 22 def parse_tag_with_name(tag_name, text) name, text = *extract_name_from_text(text) Tag.new(tag_name, text, nil, name) end
Parses tag text and creates a new tag with a key name and descriptive text
@param tag_name the name of the tag to parse @param [String] text the raw tag text @return [Tag] a tag object with the tag_name, name and text values filled
Source
# File lib/yard/tags/default_factory.rb, line 89 def parse_tag_with_options(tag_name, text) name, text = *extract_name_from_text(text) OptionTag.new(tag_name, name, parse_tag_with_types_name_and_default(tag_name, text)) end
Source
# File lib/yard/tags/default_factory.rb, line 70 def parse_tag_with_title_and_text(tag_name, text) title, desc = *extract_title_and_desc_from_text(text) Tag.new(tag_name, desc, nil, title) end
Source
# File lib/yard/tags/default_factory.rb, line 33 def parse_tag_with_types(tag_name, text) name, types, text = *extract_types_and_name_from_text(text) raise TagFormatError, "cannot specify a name before type list for '@#{tag_name}'" if name Tag.new(tag_name, text, types) end
Parses tag text and creates a new tag with formally declared types and descriptive text
@param tag_name the name of the tag to parse @param [String] text the raw tag text @return [Tag] a tag object with the tag_name, types and text values filled
Source
# File lib/yard/tags/default_factory.rb, line 45 def parse_tag_with_types_and_name(tag_name, text) name, types, text = *extract_types_and_name_from_text(text) name, text = *extract_name_from_text(text) unless name Tag.new(tag_name, text, types, name) end
Parses tag text and creates a new tag with formally declared types, a key name and descriptive text
@param tag_name the name of the tag to parse @param [String] text the raw tag text @return [Tag] a tag object with the tag_name, name, types and text values filled
Source
# File lib/yard/tags/default_factory.rb, line 57 def parse_tag_with_types_and_title(tag_name, text) name, types, text = *extract_types_and_name_from_text_unstripped(text) if name title = name desc = text else title, desc = *extract_title_and_desc_from_text(text) end Tag.new(tag_name, desc, types, title) rescue TagFormatError Tag.new(tag_name, '', types, nil) end
Parses tag text and creates a new tag with formally declared types, a title on the first line and descriptive text
@param tag_name the name of the tag to parse @param [String] text the raw tag text @return [Tag] a tag object with the tag_name, name, types and text values filled
Source
# File lib/yard/tags/default_factory.rb, line 75 def parse_tag_with_types_name_and_default(tag_name, text) # Can't allow () in a default tag, otherwise the grammar is too ambiguous when types is omitted. open = TYPELIST_OPENING_CHARS.delete('(') close = TYPELIST_CLOSING_CHARS.delete(')') name, types, text = *extract_types_and_name_from_text(text, open, close) name, text = *extract_name_from_text(text) unless name if text && text.start_with?('(') _, default, text = *extract_types_and_name_from_text(text, '(', ')') DefaultTag.new(tag_name, text, types, name, default) else DefaultTag.new(tag_name, text, types, name, nil) end end
Private Instance Methods
Source
# File lib/yard/tags/default_factory.rb, line 101 def extract_name_from_text(text) text.strip.split(/\s+/, 2) end
Extracts the name from raw tag text returning the name and remaining value
@param [String] text the raw tag text @return [Array] an array holding the name as the first element and the
value as the second element
Source
# File lib/yard/tags/default_factory.rb, line 105 def extract_title_and_desc_from_text(text) raise TagFormatError if text.nil? || text.empty? title = nil desc = nil if text =~ /\A[ \t]\n/ desc = text else text = text.split(/\r?\n/) title = text.shift.squeeze(' ').strip desc = text.join("\n") end [title, desc] end
Source
# File lib/yard/tags/default_factory.rb, line 129 def extract_types_and_name_from_text(text, opening_types = TYPELIST_OPENING_CHARS, closing_types = TYPELIST_CLOSING_CHARS) before, list, text = *extract_types_and_name_from_text_unstripped(text, opening_types, closing_types) if list.nil? [nil, nil, text.strip] else [before ? before.strip : nil, list.map(&:strip), text.strip] end end
Parses a [], <>, {} or () block at the beginning of a line of text into a list of comma delimited values.
@example
obj.parse_types('[String, Array<Hash, String>, nil]') # => [nil, ['String', 'Array<Hash, String>', 'nil'], ""] obj.parse_types('b<String> A string') # => ['b', ['String'], 'A string']
@return [Array(String
, Array
<String>, String
)] the text before the type
list (or nil), followed by the type list parsed into an array of strings, followed by the text following the type list.
Source
# File lib/yard/tags/default_factory.rb, line 138 def extract_types_and_name_from_text_unstripped(text, opening_types = TYPELIST_OPENING_CHARS, closing_types = TYPELIST_CLOSING_CHARS) e = 0 before = String.new("") list = [String.new("")] level = 0 seen_space = false i = 0 last_seen = '' text ||= '' while i < text.length c = text[i, 1] if (c == '"' || c == "'") && text[i..-1] =~ /#{c}.+?#{c}/ list.last << $& i += $&.length next end if level > 0 && c == '#' && text[i + 1..-1] =~ CodeObjects::METHODNAMEMATCH list.last << c + $& i += $&.length + 1 next elsif opening_types.include?(c) list.last << c if level > 0 level += 1 elsif closing_types.include?(c) level -= 1 unless last_seen == '=' && c == '>' break e = i if level == 0 list.last << c elsif c == ',' && level == 1 list.push String.new("") elsif c =~ /\S/ && level == 0 break e = i if seen_space && list == [''] before << c elsif c =~ /[ \t]/ && level == 0 && !before.empty? seen_space = true elsif level >= 1 list.last << c elsif level == 0 && c == "\n" break e = i end last_seen = c i += 1 end before = before.empty? ? nil : before if list.size == 1 && list.first == '' [nil, nil, text] else [before, list, text[(e + 1)..-1]] end end