Sha256: 93021bac478721c9d2f1b2dcef96da72e92946f1b1c71ef5163e7eb20953649b
Contents?: true
Size: 1.42 KB
Versions: 9
Compression:
Stored size: 1.42 KB
Contents
module YARD
module Templates::Helpers
# Helpers for UML template format
module UMLHelper
# Official UML visibility prefix syntax for an object given its visibility
# @param [CodeObjects::Base] object the object to retrieve visibility for
# @return [String] the UML visibility prefix
def uml_visibility(object)
case object.visibility
when :public; '+'
when :protected; '#'
when :private; '-'
end
end
# Formats the path of an object for Graphviz syntax
# @param [CodeObjects::Base] object an object to format the path of
# @return [String] the encoded path
def format_path(object)
object.path.gsub('::', '_')
end
# Encodes text in escaped Graphviz syntax
# @param [String] text text to encode
# @return [String] the encoded text
def h(text)
text.to_s.gsub(/(\W)/, '\\\\\1')
end
# Tidies data by formatting and indenting text
# @param [String] data pre-formatted text
# @return [String] tidied text.
def tidy(data)
indent = 0
data.split(/\n/).map do |line|
line.gsub!(/^\s*/, '')
next if line.empty?
indent -= 1 if line =~ /^\s*\}\s*$/
line = (' ' * (indent * 2)) + line
indent += 1 if line =~ /\{\s*$/
line
end.compact.join("\n") + "\n"
end
end
end
end
Version data entries
9 entries across 9 versions & 1 rubygems